{ "openapi":"3.0.1", "info":{ "title":"Oracle Primavera Cloud REST API", "version":"2026.04.29", "description":"The Oracle Primavera Cloud REST API provides a flexible interface to Oracle Primavera Cloud functionality.", "x-summary":"The Oracle Primavera Cloud REST API provides a flexible interface to Oracle Primavera Cloud functionality." }, "servers":[ { "url":"/api/restapi" } ], "tags":[ { "name":"Action", "description":"The Action service enables you to schedule jobs, work with project baselines and snapshots, and manage project period items. A job represents a background process within the application. There are several background services that may initiate jobs, such as scheduler, leveler, risk analysis, and measures. Completed scheduling, leveling, and measure jobs generate job logs that include additional details about the service." }, { "name":"Activity", "description":"Use the Activity service to create, view, update, and delete activities. Activities represent units of work that must be completed to accomplish your project objectives. Activities typically have durations, resource or role requirements, and logical relationships with other project activities. Update Keys : 'activityId' " }, { "name":"Activity Aggregate", "description":"Use the Activity Aggregate service to view activity groupings. Activity aggregates sum the activity data of activities that meet certain criteria. Use activity aggregates to access a general overview of activity data for a particular project, work package, or portfolio. " }, { "name":"Activity Favorite", "description":"Use the Activity Favorite service to create, view and delete activity favorites. Activities represent units of work that must be completed to accomplish your project objectives. Activities typically have durations, resource or role requirements, and logical relationships with other project activities. Mark objects as favorites in order to access them within the Favorites section of apps and Browse popovers. Update Keys : 'activityFavoriteId' " }, { "name":"Activity Relationship", "description":"Use the Activity Relationship service to create, view, update, and delete activity relationships. Relationships define how an activity relates to the start or finish of another activity and indicate whether activities must be completed sequentially or can be done in parallel. Update Keys : 'relationshipId' " }, { "name":"Activity Risk", "description":"Use the Activity risk service to create, view, update, and delete activity risks. Activity Risks indicate whether risks from the project risk register will impact a project activity and potentially cause schedule delays. Activity risks represent the assignment of a risk to an activity, and are also used during the risk analysis process to simulate the impact of project risks on activities. Update Keys : 'activityRiskId' " }, { "name":"Application User Group", "description":"Use the Application User Group service to create, view, update, and delete user groups. Update Keys : 'applicationUserGroupId' " }, { "name":"Assignment", "description":"The Assignment service enables you to create, view, update, and delete assignments. Assignments represent the allocation of project or workspace resources to project activities. Update Keys : 'assignmentId' " }, { "name":"Assignment Favorite", "description":"The Assignment Favorite service enables you to mark or unmark assignments as favorites. Assignments represent the allocation of project or workspace resources to project activities. Mark objects as favorites in order to access them within the Favorites section of apps and Browse popovers. Update Keys : 'assignmentFavoriteId' " }, { "name":"Baseline Category", "description":"Use the Baseline Category service to create, view, update, and delete baseline categories. Update Keys : 'baselineCategoryId' " }, { "name":"Budget Planning Scenario", "description":"Use the Budget Planning Scenario service to create, view, update, and delete budget planning scenarios. Update Keys : 'scenarioId' " }, { "name":"CBS", "description":"Use the CBS service enables you to create, view, update, or delete cost breakdown structure codes for a workspace or project. A CBS is used to track, manage, and report costs related to a project. CBS codes enable you to define and track custom cost data within project or workspace CBS." }, { "name":"CBS Segment", "description":"Use the Cost Breakdown Structure Segment service to create, view, update, and delete CBS segments for workspaces and projects. CBS Segments determine the hierarchical depth of a CBS and designate how CBS codes are concatenated. Update Keys : 'segmentId' " }, { "name":"Calendar", "description":"Use the Calendar service to create, view, update, and delete calendars. Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles. Update Keys : 'calendarId' " }, { "name":"Calendar Exception", "description":"Use the Calendar service to create, view, update, and delete calendars. Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles. Update Keys : 'calendarExceptionId' " }, { "name":"Capital Portfolio Member", "description":"Use the Capital Portfolio Member service to create, view, and delete capital portfolio members. Capital portfolio members are references to projects or portfolios contained in a capital portfolio. Update Keys : 'capitalPortfolioMemberId' " }, { "name":"Change Request", "description":"Use the Change Requests service to create, view, update, and delete change requests. Change requests track changes to work packages and scope assignments after an original project baseline is set." }, { "name":"Code Type", "description":"Use the Code Type service to create, view, update, and delete code types. Codes are user-defined data used to organize and filter objects. Codes are defined as combinations of types and values. For example, you can define a \"Priority\" code type that contains text values, and create a set of potential values for the type for use across projects. Update Keys : 'codeTypeId' " }, { "name":"Code Value", "description":"Use the Code Value service to create, view, update, and delete code values. Codes are user-defined data used to organize and filter objects. Codes are defined as combinations of types and values. For example, you can define a \"Priority\" code type that contains text values, and create a set of potential values for the type for use across projects." }, { "name":"Company", "description":"The Company service enables you to create, view, update, or delete companies. Multiple companies can work together using the same environment. For example, if the owning company hires a design firm and a subcontractor to work on the same project, the owning company can add both of the other companies as partner companies. The owning company can also add users to the partner companies and give them access to workspaces, projects, and portfolios. Two types of companies are supported: Owning Company: Represents the company with ownership of the application instance. Owning companies cannot be deleted. Partner Company: A separate entity from the owning company that needs access to the application. Partner companies represent vendors, resellers, subcontractors, owners, suppliers, and other consultants." }, { "name":"Configured Fields", "description":"The Configured Fields service enables you to send requests related to fields and codes configured for use in the application. Update Keys : 'columnDefinitionId' " }, { "name":"Constraint", "description":"Use the constraint service to create, view, update, and delete constraints. Update Keys : 'constraintId' " }, { "name":"Cost Category", "description":"Use the Cost Category service to create, view, update, and delete cost categories. Cost categories define types used to organize costs. Update Keys : 'costCategoryId' " }, { "name":"Currency", "description":"The Currency service enables you to create, view, update, and delete currencies. Currencies track the costs of your projects using a specified monetary system. Currencies can be defined at the workspace or project level. Update Keys : 'currencyId' " }, { "name":"Curve", "description":"Use the Curve service to create, view, update, and delete curves. Curves specify how values such as scope assignment quantities and hours are spread across the duration of an activity. Update Keys : 'curveId' " }, { "name":"Custom Log Item", "description":"The Custom Log service enables you to send requests related to custom logs. Update Keys : 'customLogTypeObjectId, customLogItemCode' or 'customLogItemId' or 'workspaceCode, projectCode, customLogTypeObjectName, customLogItemCode' or 'projectId, customLogTypeObjectName, customLogItemCode' " }, { "name":"Custom Log Type Object", "description":"The Custom Log Object Type service enables you to send requests related to custom log object types. Update Keys : 'scope, scopeId, customLogObjectName' or 'customLogTypeObjectId' or 'workspaceCode, scope, scopeCode, customLogTypeObjectName' " }, { "name":"Dictionary", "description":"Use the Dictionary service to manage all the dictionary objects's shared data. " }, { "name":"Discussion", "description":"Use the Discussion service to view Activity or Task Discussions." }, { "name":"Document", "description":"Use the Document service to create, view, update, and delete documents. Documents are drawings, submittals, RFIs, or other files that support your organization's goals. Update Keys : 'id' " }, { "name":"Document Folder Structure Template", "description":"Use the Document Folder Structure Template Service to create, view, update, or delete document folder structure templates. Update Keys : 'documentFolderStructureTemplateId' " }, { "name":"Evaluation Categories", "description":"Use the Evaluation Category service to view evaluation matrix, and update evaluation rank. Update Keys : 'evaluationMatrixId' " }, { "name":"Exchange Rate", "description":"Use the Exchange Rate service to create, view, update, and delete exchange rates for a given currency. Exchange rates are conversion rates between different forms of currency. Update Keys : 'exchangeRateId' " }, { "name":"Fund Actual", "description":"Use the Fund Actual service to allocate funds to project actuals. Update Keys : 'fundActualId' " }, { "name":"Funds", "description":"Use the fund service to create, update, delete, and view funds. Update Keys : 'fundId' " }, { "name":"Global Permissions", "description":"Use the global permissions service to view global permission sets." }, { "name":"Holiday", "description":"Use the Holiday service to create, view, update, and delete holidays. Holidays represent times within a calendar on which work will not be scheduled. Update Keys : 'holidayId' " }, { "name":"Holiday List", "description":"Use the Holiday List service to create, view, update, and delete holiday lists. Holiday lists are collections of public or company holidays. Update Keys : 'holidayListId' " }, { "name":"Idea", "description":"Use the idea service you to create, view, update, and delete idea. Update Keys : 'workspaceCode, ideaName' or 'ideaId' " }, { "name":"Location", "description":"Use the Location service to create, view, update, and delete locations. A location is a geographical reference defined by a pair of coordinates, longitude and latitude. Update Keys : 'locationId' " }, { "name":"Measure", "description":"The Measure service enable you to create, update, view, and delete measures. Update Keys : 'measureId' " }, { "name":"Measure Threshold", "description":"Use the Measure Threshold service to create, view, update, and delete measure thresholds. Update Keys : 'measureThresholdId' " }, { "name":"Monte Carlo Activity Delta", "description":"Use the Monte Carlo Activity Delta service to view Monte Carlo activity delta data. " }, { "name":"Monte Carlo Activity Deterministic Values", "description":"Use the Monte Carlo Activity Deterministic Values service to view Monte Carlo Activity Deterministic Values." }, { "name":"Monte Carlo Activity Iteration Values", "description":"Use the Monte Carlo Activity Iteration Values service to view Monte Carlo Activity Iteration Values." }, { "name":"Monte Carlo Activity Result", "description":"Use the Monte Carlo Activity Result service to view Monte Carlo Activity Result data." }, { "name":"Monte Carlo Activity Risk Result", "description":"Use the Monte Carlo Activity Risk Result service to send view Monte Carlo Activity Risk Result data." }, { "name":"Monte Carlo Project Delta", "description":"Use the MonteCarlo Project Delta service to view MonteCarlo Project Delta data." }, { "name":"Monte Carlo Project Deterministic Values", "description":"Use the Monte Carlo Project Deterministic Values service to view Monte Carlo Project Deterministic Values." }, { "name":"Monte Carlo Project Iteration Values", "description":"Use the Monte Carlo Project Iteration Values service to view Monte Carlo Project Iteration Values." }, { "name":"Monte Carlo Project Result", "description":"Use the Monte Carlo Project Result service to view Monte Carlo Project Result data." }, { "name":"Monte Carlo Risk Result", "description":"Use the Monte Carlo Risk Result service to view Monte Carlo Risk Result data." }, { "name":"Monte Carlo Run Settings", "description":"Use the Monte Carlo Run Settings service to view Monte Carlo Run Settings." }, { "name":"Monte Carlo Settings", "description":"Use the Monte Carlo Settings service to create, view, and update Monte Carlo Settings." }, { "name":"Notebook Topics", "description":"Use the Notebook Topics service to create, view, update, and delete notebook topics." }, { "name":"Office", "description":"The Office service enables you to create, view, update, or delete offices." }, { "name":"P6 Import Export", "description":"Use the P6 Import Export service to import or export project data as an XML or XER file." }, { "name":"PBS", "description":"Use the PBS service to create, view, and delete defined Project, Product, or Plant Breakdown Structures. A PBS is a hierarchical representation of the materials or products required to complete a project. Update Keys : 'pbsId' " }, { "name":"Period Closeout Record", "description":"Use the Period Closeout service to view period closeouts." }, { "name":"Portfolio", "description":"Use the Portfolio service to create, view, update, and delete portfolios. Portfolios are collections of projects or other portfolios that enable you to plan resource and budget allocations across the collection. Update Keys : 'capitalPortfolioId' " }, { "name":"Portfolio Measure", "description":"Use the Portfolio Measure service to create, view, update, and delete portfolio measures. Portfolio measures represent associations between measures and portfolios. Update Keys : 'portfolioMeasureId' " }, { "name":"Portfolio Measure Manual Value", "description":"The Portfolio Measure Manual Value resource enables you to create, view, update, and delete portfolio measure manual values." }, { "name":"Portfolio Measure Value", "description":"Use the Portfolio Measure Value service to view portfolio measure values." }, { "name":"Portfolio Project", "description":"Use the Portfolio Project service to create, view, update, and delete portfolio projects. Portfolio projects are references to projects that belong to a portfolio. Portfolio projects contain the system-generated identifiers of the project, as well as the identifier of the portfolio the project belongs to." }, { "name":"Program", "description":"Use the Program service to create, view, update, and delete programs. Update Keys : 'workspaceId, programCode' or 'programId' or 'workspaceCode, programCode' " }, { "name":"Program Budget", "description":"Use the Program Budget services to view program budgets." }, { "name":"Program Budget Change", "description":"The Budget Change service enables you to create, view, update, and delete program budget change requests. Program Budget change requests represent potential modifications to program budgets. Update Keys : 'programBudgetChangeId' " }, { "name":"Program Budget Item", "description":"Use the Program Program Budget Item service to create, view, update, and delete program budget items. Budget items represent costs associated with labor or other program expenses. Update Keys : 'programBudgetItemId' " }, { "name":"Program Budget Transfer", "description":"Use the Program Budget Transfer service to create, view, update, delete program budget transfers. Program Budget transfers represent adjustments to program budget line item costs, and capture costs that were moved from one line item to another. Update Keys : 'programBudgetTransferId' " }, { "name":"Program Measure Value", "description":"The Program Measure Value service enables you to send and retrieve information related to Program Measure Values. Update Keys : 'programMeasureValueId' " }, { "name":"Program Risk", "description":"Use the Program Risk service to create, view, update, and delete program risks. Update Keys : 'programRiskId' " }, { "name":"Program Risk Mitigation", "description":"The Program Risk Mitigation service enables you to create, update, view, and delete program risk mitigations. Program Risk Mitigation is also referred to as Program Risk Response Action. Update Keys : 'programRiskMitigationId' " }, { "name":"Program Risk Weather Period", "description":"The Program Risk Weather Period service enables you to create, update, view, and delete program risk weather periods. Update Keys : 'programRiskWeatherPeriodId' " }, { "name":"Project", "description":"Use the Project service to create, view, update, and delete projects. Projects are company initiatives and goals you manage Update Keys : 'projectId' " }, { "name":"Project Actuals", "description":"Use the Project Actuals service to create, view, update, and delete project actuals. Project actuals are manual or scope based costs that represent pending or confirmed spending on your projects. Update Keys : 'projectActualsId' " }, { "name":"Project Actuals Line Item", "description":"Use the Project Actuals Line Items service to create, view, update, and delete project actual line items. Update Keys : 'projectActualsLineItemId' " }, { "name":"Project Budget", "description":"Use the Project Budget services to view project budgets." }, { "name":"Project Budget Change", "description":"The Project Budget Change service enables you to create, view, update, and delete project budget change requests. Project Budget Change requests represent potential modifications to project budgets. Update Keys : 'budgetChangeId' " }, { "name":"Project Budget Item", "description":"Use the Project Budget Item service to create, view, update, and delete project budget items. Project Budget Items represent costs associated with labor or other project expenses. Update Keys : 'budgetItemId' " }, { "name":"Project Budget Transfer", "description":"Use the Project Budget Transfer service to create, view, update, delete, and status project budget transfers. Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another. Update Keys : 'budgetTransferId' " }, { "name":"Project Cashflows", "description":"Use the Project Cashflow service to create, view, update, and delete project cashflows. Update Keys : 'projectPhaseFinancialId' " }, { "name":"Project Company", "description":"Use the Project Company service to view companies associated with projects. Update Keys : 'projectCompanyId' " }, { "name":"Project Dependency", "description":"Use the Project Dependency service to create, view, update, and delete project dependencies. Dependencies specify direct relationships between projects and indicate the progress of one project is reliant upon the progress of another. Update Keys : 'projectDependencyId' " }, { "name":"Project Measure Value", "description":"The Project Measure Value service enables you to send and retrieve information related to Project Measure Values." }, { "name":"Project Rank", "description":"The Project Rank service enables you to send and retrieve information related to a project's rank. Update Keys : 'projectRankId' " }, { "name":"Project Resource Work Rate", "description":"The Project Resource Work Rate service enables you to send and retrieve information related to work rate of a project's resource. Update Keys : 'projectResourceWorkRateId' " }, { "name":"Project Risk", "description":"Use the Project Risk service to create, view, update, and delete project risks. Update Keys : 'projectRiskId' " }, { "name":"Project Risk Mitigation", "description":"The Project Risk Mitigation service enables you to create, update, view, and delete project risk mitigations. Project Risk Mitigation is also referred to as Project Risk Response Action. Update Keys : 'riskMitigationId' " }, { "name":"Project Risk Weather Period", "description":"The Project Risk Weather Period service enables you to create, update, view, and delete project risk weather periods. Update Keys : 'riskWeatherPeriodId' " }, { "name":"Projects Aggregate", "description":"Use the Projects Aggregate service to view project information aggregated with budget plans and project portfolios." }, { "name":"Reason", "description":"Use the Reason service to create, view, update, and delete reasons. Reasons provide justifications for recommitting to a task. Update Keys : 'reasonId' " }, { "name":"Related Items", "description":"Use the entity reference service to create, view, and delete references between application objects. Update Keys : 'entityReferenceId' " }, { "name":"Report", "description":"Use the Report service to view reports." }, { "name":"Report Cycle", "description":"Use the Report Cycle service to create, view, update, and delete report cycles created within a project. Report cycles represent the planning periods used to plan and update scope assignment progress. Update Keys : 'reportCycleId' " }, { "name":"Resource", "description":"The Workspace Resource service enables you to create, view, update, and delete workspace resources. Resources represent any quantifiable item you can track and assign to specific activities in a project. Update Keys : 'resourceId' " }, { "name":"Resource Demand", "description":"Use the Resource Demand service to create, view, update, and delete resource demands. A resource demands represent the high-level role requirements of a project. Update Keys : 'resourceDemandId' " }, { "name":"Resource Planning Scenario", "description":"Use the Resource Planning Scenario service to create, view, update, and delete resource plans. Update Keys : 'scenarioId' " }, { "name":"Resource Role Assignment", "description":"The Resource Role Assignment services enables you to create, view, update, and delete assignments between resources and roles. A resource role assignment indicates whether or not a resource is fulfilling a particular role. Update Keys : 'resourceRoleAssignmentId' " }, { "name":"Resource Work Rate", "description":"Use the Resource Work Rate service to create, view, update, and delete workspace resource rates for resources or roles. Update Keys : 'resourceWorkRateId' " }, { "name":"Risk Matrix", "description":"Use the Risk Matrix service to create, view, update, and delete risk matrixes. Update Keys : 'riskMatrixId' " }, { "name":"Risk Score Type", "description":"Use the Risk Score Type service to create, view, update, and delete risk score types. Risk Score Types specify thresholds which can be used to quantitatively compare the anticipated impacts of risks." }, { "name":"Rule Of Credit", "description":"Use the Rule of Credit service to create, view, update, and delete rules of credit. Rules of credit can be used when tracking progress on scope assignments. A rule is defined by its milestones and their percentage complete. Update Keys : 'workspaceId, rocName' or 'rocId' or 'workspaceCode, rocName' " }, { "name":"Schedule Scenario", "description":"Use the Schedule Scenarios service to create, view, update, and delete schedule scenarios. Update Keys : 'scenarioId' " }, { "name":"Scope Assignment Actuals Time Phased Data", "description":"The Scope Assignment Actuals Time Phased Data service enables you to create, view, update, and delete scope assignment time phased actuals data. Update Keys : 'scopeAssignmentActualsTimePhasedDataId' " }, { "name":"Scope Assignment Baseline Time Phased Data", "description":"Use the Scope Assignment Baseline Time Phased Data service to view, create, update and delete scope assignment baseline time phased data. Update Keys : 'scopeAssignmentBaselineTimePhasedDataId' " }, { "name":"Scope Assignment Installed Time Phased Data", "description":"Use the Scope Assignment Installed Time phased data service enables you to send requests related to scope assignment installed time phased data. Update Keys : 'scopeAssignmentInstalledTimePhasedDataId' " }, { "name":"Scope Assignment Planned Time Phased Data", "description":"Use the scope assignment planned time phased data service to view scope assignment planned time phased data. Update Keys : 'scopeAssignmentPlannedTimePhasedDataId' " }, { "name":"Scope Item", "description":"Use the Scope Item service to create, view, update, and delete scope items. Scope Items represent materials or products needed to complete a project." }, { "name":"Scope Item Assignment", "description":"Use the Scope Item Assignment service to create, view, update, and delete scope assignments. Update Keys : 'scopeItemAssignmentId' " }, { "name":"Scope Item Assignment Activity", "description":"Use the Scope Item Assignment Activity service to create, view, update, and delete scope assignments and activity relationships. Update Keys : 'scopeItemAssignmentActivityId' " }, { "name":"Spreads", "description":"Use the Spreads service to calculate the activity or assignment spread and to download the spread results." }, { "name":"Strategy", "description":"Use the Strategy service you to create, view, update, and delete strategies. Update Keys : 'strategyId' " }, { "name":"Strategy Measure", "description":"Use the Strategy Measure service to create, view, update, and delete Strategy Measures. Update Keys : 'strategyMeasureId' " }, { "name":"Strategy Measure Manual Value", "description":"Use the Strategy Measure Manual Value service to create, view, update, and delete Strategy Measure Manual Values. Update Keys : 'strategyMeasureValueXReferenceId' " }, { "name":"Strategy Measure Value", "description":"Use the Strategy Measure Value service to view strategy measure values." }, { "name":"Strategy Project", "description":"Use the Strategy Project service to create, view, update, and delete strategy projects. Update Keys : 'strategyProjectId' " }, { "name":"Strategy Type", "description":"Use the Strategy Type service to create, view, up send and retrieve information related to strategy types. Update Keys : 'strategyTypeId' " }, { "name":"Task", "description":"Use the task service to create, view, update, and delete tasks. Update Keys : 'workManagerTaskId' " }, { "name":"Task Commitment", "description":"Use the Task Commitment service to create, and delete task commitments. Update Keys : 'workManagerTaskCommitmentId' " }, { "name":"Task Handoff", "description":"Use the Task Handoff service to create, view, update, and delete task handoffs. Update Keys : 'workManagerTaskDependencyId' " }, { "name":"Threshold", "description":"The Threshold service enables you to create, view, update, and delete thresholds. Thresholds are visual indicators used to convey the current status of a value compared to upper and lower limits. Update Keys : 'thresholdId' " }, { "name":"Units Of Measure", "description":"Use the Units of Measure service to create, view, update, and delete units of measure. Update Keys : 'unitOfMeasureId' " }, { "name":"User", "description":"Use the User service to view and update users. Update Keys : 'email' or 'userId' or 'ldapGuid' " }, { "name":"User Preferences", "description":"Use the User Preferences service to view and update user preferences. User preferences determine data display formats and personal details, and are exclusive to each user. Update Keys : 'applicationUserSettingId' " }, { "name":"Util", "description":"Contains utility end points for Oracle Primavera Cloud Rest API" }, { "name":"WBS", "description":"Use the WBS service to create, view, update, and delete workspace breakdown structures. Work Breakdown Structures (WBS) represent hierarchical arrangements of the work required to bring a project to completion. Update Keys : 'wbsId' " }, { "name":"Work Package", "description":"The Work Package service enables you to send requests related to the defined work package. Update Keys : 'workPackageId' " }, { "name":"Workflow", "description":"Use the Workflow service to to start a workflow. " }, { "name":"Workflow Instance", "description":"Use the Workflow Instance service to to view monitor workflow information. " }, { "name":"Workspace", "description":"Use the Workspace service to create, update, delete, and view workspaces. Update Keys : 'workspaceId' " } ], "paths":{ "/action/computeMeasure":{ "post":{ "tags":[ "Action" ], "summary":"Schedule Portfolio Measure Computation", "description":"Send a request to this endpoint to schedule a computation job for portfolio measures. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs.", "operationId":"/action/computeMeasure_computeMeasures", "requestBody":{ "description":"A list of one or more unique identifiers of portfolios.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-computeMeasure-post", "x-filename-id":"action-computemeasure-post" } }, "/action/computeStrategyMeasure":{ "post":{ "tags":[ "Action" ], "summary":"Schedule Strategy Measure Computation", "description":"Send a request to this endpoint to schedule a computation job for strategy measures. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs.", "operationId":"/action/computeStrategyMeasure_computeStrategyMeasures", "requestBody":{ "description":"A list of one or more unique identifiers of strategies.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-computeStrategyMeasure-post", "x-filename-id":"action-computestrategymeasure-post" } }, "/action/baseline":{ "get":{ "tags":[ "Action" ], "summary":"View Project Baseline By Name", "description":"Send a request to this endpoint to get the project baseline by its name.", "operationId":"/action/baseline_findBaselineByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"name", "in":"query", "description":"The user-specified identifier of a project baseline.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaseline", "$ref":"#/components/schemas/ApiEntityBaseline", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-baseline-get", "x-filename-id":"action-baseline-get" }, "put":{ "tags":[ "Action" ], "summary":"Update Project Baseline", "description":"Update a project baseline using either projectBaselineId or the set of parent codes, providing the fields in the body that needs to be updated.", "operationId":"/action/baseline_updateBaseline", "requestBody":{ "description":"A project baseline JSON object. The object must conform to the ApiEntityBaseline schema.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaselineInput", "$ref":"#/components/schemas/ApiEntityBaselineInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Baseline":{ "summary":"Update a Project Baseline", "description":"Payload to update the project baseline using the project ID, name and type.", "value":{ "projectId":204101, "name":"James Street Construction", "type":"ORIGINAL" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"action-baseline-put", "x-filename-id":"action-baseline-put" }, "post":{ "tags":[ "Action" ], "summary":"Create a Project Baseline", "description":"Send a request to this endpoint to create a project baseline. Baselines are static representations of project plans against which project performance may be benchmarked or measured.", "operationId":"/action/baseline_createBaseline", "requestBody":{ "description":"A baseline time phased data object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaselineInput", "$ref":"#/components/schemas/ApiEntityBaselineInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Baseline":{ "summary":"Create a Project Baseline", "description":"Payload to create a project baseline using the project ID, name, description, and status.", "value":{ "projectId":204101, "name":"James Street Construction", "description":"Schedule of James Street Construction", "status":"IN_PROGRESS" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaseline", "$ref":"#/components/schemas/ApiEntityBaseline", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-baseline-post", "x-filename-id":"action-baseline-post" }, "delete":{ "tags":[ "Action" ], "summary":"Delete Project Baseline By Name", "description":"Delete a project baseline providing the projectBaseline details as query parameters, that needs to be deleted.", "operationId":"/action/baseline_deleteBaslineByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"name", "in":"query", "description":"The user-specified identifier of a project baseline.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"action-baseline-delete", "x-filename-id":"action-baseline-delete" } }, "/action/capitalPlanSnapshot":{ "post":{ "tags":[ "Action" ], "summary":"Create a Budget Plan Snapshot", "description":"Send a request to this endpoint to create a budget plan snapshot. Budget plan snapshots capture the state of an approved budget plan at a particular point in time. Use budget plan snapshots to capture the history of a portfolio budget plan and monitor the progress of projects included in the plan.", "operationId":"/action/capitalPlanSnapshot_createCPSnapshot", "requestBody":{ "description":"JSON representation of a budget plan object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCapitalPlanSnapshotInput", "$ref":"#/components/schemas/ApiEntityCapitalPlanSnapshotInput", "exampleSetFlag":false }, "examples":{ "Create_a_Budget_Plan_Snapshot":{ "summary":"Create a Budget Plan Snapshot", "description":"Payload to create a budget plan snapshot using the capital plan ID, snapshot ID, and name.", "value":{ "capitalPlanId":72001, "snapshotId":16101, "name":"Budget Alignment" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCapitalPlanSnapshot", "$ref":"#/components/schemas/ApiEntityCapitalPlanSnapshot", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-capitalPlanSnapshot-post", "x-filename-id":"action-capitalplansnapshot-post" } }, "/action/projectSnapshot":{ "post":{ "tags":[ "Action" ], "summary":"Create a Project Snapshot", "description":"Send a request to this endpoint to create a Cash Flow snapshot. Cash Flow snapshots capture the state of the project cash flow at a particular point in time. Use project snapshots to monitor changes to cash flow data over time.", "operationId":"/action/projectSnapshot_createProjectSnapshot", "requestBody":{ "description":"Project Snapshot to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectSnapshotInput", "$ref":"#/components/schemas/ApiEntityProjectSnapshotInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Snapshot":{ "summary":"Create a Project Snapshot", "description":"Payload to create a project snapshot using the project ID, name, description, and type.", "value":{ "projectId":204101, "name":"Phase 1 -James Street Construction", "description":"Status of Phase 1 - James Street Construction", "type":"PROJECT" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectSnapshot", "$ref":"#/components/schemas/ApiEntityProjectSnapshot", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-projectSnapshot-post", "x-filename-id":"action-projectsnapshot-post" } }, "/action/baseline/{projectBaselineId}":{ "get":{ "tags":[ "Action" ], "summary":"View Project Baseline", "description":"Send a request to this endpoint to get the project baselines by its Id.", "operationId":"/action/baseline/{projectBaselineId}_findBaselineById", "parameters":[ { "name":"projectBaselineId", "in":"path", "description":"Value of projectBaselineId, the system-generated identifier of a project baseline.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaseline", "$ref":"#/components/schemas/ApiEntityBaseline", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-baseline-{projectBaselineId}-get", "x-filename-id":"action-baseline-projectbaselineid-get" }, "delete":{ "tags":[ "Action" ], "summary":"Delete Project Baseline", "description":"Delete a project baseline providing the projectBaselineId that needs to be deleted.", "operationId":"/action/baseline/{projectBaselineId}_deleteBaslineById", "parameters":[ { "name":"projectBaselineId", "in":"path", "description":"Value of projectBaselineId, the system-generated identifier of a project baseline.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"action-baseline-{projectBaselineId}-delete", "x-filename-id":"action-baseline-projectbaselineid-delete" } }, "/action/capitalPlan/snapshot/{snapshotId}":{ "delete":{ "tags":[ "Action" ], "summary":"Delete a Budget Plan Snapshot", "description":"Send a request to this endpoint to delete a budget plan snapshot with an ID value matching the value of the {snapshotId} path parameter. Budget plan snapshots capture the state of an approved budget plan at a particular point in time. Use budget plan snapshots to capture the history of a portfolio budget plan and monitor the progress of projects included in the plan.", "operationId":"/action/capitalPlan/snapshot/{snapshotId}_deleteCPSnapshot", "parameters":[ { "name":"snapshotId", "in":"path", "description":"JSON representation of a budget plan object.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Action service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"action-capitalPlan-snapshot-{snapshotId}-delete", "x-filename-id":"action-capitalplan-snapshot-snapshotid-delete" } }, "/action/project/snapshot/{snapshotId}":{ "delete":{ "tags":[ "Action" ], "summary":"Delete a Project Snapshot", "description":"Send a request to this endpoint to delete a Cash Flow snapshot with an ID value matching the value of the {id} path parameter. Cash Flow snapshots capture the state of project cash flow at a particular point in time. Use project snapshots to monitor changes to cash flow data over time.", "operationId":"/action/project/snapshot/{snapshotId}_deleteProjectSnapshot", "parameters":[ { "name":"snapshotId", "in":"path", "description":"Project Snapshot to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Action service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"action-project-snapshot-{snapshotId}-delete", "x-filename-id":"action-project-snapshot-snapshotid-delete" } }, "/action/baseline/parent":{ "get":{ "tags":[ "Action" ], "summary":"View Project Baseline By Parent Code", "description":"Send a request to this endpoint to get all the project baselines under the project using the set of parent codes as query parameters.", "operationId":"/action/baseline/parent_findBaselineByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaseline", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"action-baseline-parent-get", "x-filename-id":"action-baseline-parent-get" } }, "/action/baseline/project/{id}":{ "get":{ "tags":[ "Action" ], "summary":"View Project Baseline By Project", "description":"Send a request to this endpoint to get all the project baselines under the project.", "operationId":"/action/baseline/project/{id}_findBaselineByProjectId", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaseline", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"action-baseline-project-{id}-get", "x-filename-id":"action-baseline-project-id-get" } }, "/action/jobStatus/{jobId}":{ "get":{ "tags":[ "P6 Import Export", "Spreads", "Project Cashflows", "Action" ], "summary":"View Job Status", "description":"Send a request to this endpoint to view the current status of a job with an ID value matching the value of the {jobId} path parameter. A job represents a background process within the application. There are several background services, such as scheduler, leveler, risk analysis, and measures, that may initiate jobs. Completed scheduling, leveling, and measures jobs generate a job log that includes additional details about the service.", "operationId":"/action/jobStatus/{jobId}_findJobStatus", "parameters":[ { "name":"jobId", "in":"path", "description":"The unique identifier of a scheduled job.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"includeJobLog", "in":"query", "description":"Whether the job log needs to be returned in the response or not. Allowed Values: [TRUE, FALSE] ", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityJobDetail", "$ref":"#/components/schemas/ApiEntityJobDetail", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-jobStatus-{jobId}-get", "x-filename-id":"action-jobstatus-jobid-get" } }, "/action/snapshot/capitalPlan/{capitalPlanId}":{ "get":{ "tags":[ "Action" ], "summary":"View Snapshots by Budget Plan ID", "description":"Send a request to this endpoint to view snapshots associated to a budget plan with an ID value matching the value of the {id} path parameter. Budget plan snapshots capture the state of an approved budget plan at a particular point in time. Use budget plan snapshots to capture the history of a portfolio budget plan and monitor the progress of projects included in the plan.", "operationId":"/action/snapshot/capitalPlan/{capitalPlanId}_getCPSnapshot", "parameters":[ { "name":"capitalPlanId", "in":"path", "description":"View Budget Plan Snapshots", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio snapshot transfer does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCapitalPlanSnapshot", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"action-snapshot-capitalPlan-{capitalPlanId}-get", "x-filename-id":"action-snapshot-capitalplan-capitalplanid-get" } }, "/action/snapshot/project/{id}":{ "get":{ "tags":[ "Action" ], "summary":"View Snapshots by Project ID", "description":"Send a request to this endpoint to view Cash Flow snapshots associated to a project with an ID value matching the value of the {id} path parameter. Cash Flow snapshots capture the state of project cash flow at a particular point in time. Use project snapshots to monitor changes to cash flow data over time.", "operationId":"/action/snapshot/project/{id}_getProjectSnapshot", "parameters":[ { "name":"id", "in":"path", "description":"Returns the snapshots for project id.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project snapshot does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectSnapshot", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"action-snapshot-project-{id}-get", "x-filename-id":"action-snapshot-project-id-get" } }, "/action/reportResult/{jobId}":{ "get":{ "tags":[ "Action" ], "summary":"Download a Report", "description":"Send a request to this endpoint to download a report with an ID value matching the value of the {id} path parameter. Reports are user-defined synopses that contain detailed or summarized information about your projects. Reports may be output in a variety of file formats, including PDF, XLS, RTF, HTML, and XML.", "operationId":"/action/reportResult/{jobId}_getReportResult", "parameters":[ { "name":"jobId", "in":"path", "description":"The unique identifier of a job.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"action-reportResult-{jobId}-get", "x-filename-id":"action-reportresult-jobid-get" } }, "/action/importWBS":{ "post":{ "tags":[ "Action" ], "summary":"Import a WBS from Project", "description":"Send a request to this endpoint to import a WBS from a project or project template.", "operationId":"/action/importWBS_importWBSFromProject", "requestBody":{ "description":"An object specifying a WBS import data.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWBSImportInput", "$ref":"#/components/schemas/ApiEntityWBSImportInput", "exampleSetFlag":false }, "examples":{ "Import_a_WBS_from_Project":{ "summary":"Import a WBS from Project", "description":"Payload to import a WBS using the copy options, source WBS, and target WBS.", "value":{ "copyOptions":[ "ACTIVITIES" ], "sourceWBS":{ "wbsId":210101 }, "targetWBS":{ "wbsId":210102 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWBSImportResponse", "$ref":"#/components/schemas/ApiEntityWBSImportResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-importWBS-post", "x-filename-id":"action-importwbs-post" } }, "/action/level":{ "post":{ "tags":[ "Action" ], "summary":"Perform Project Resource Leveling", "description":"Send a request to this endpoint to perform project resource leveling. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs. Resource leveling ensures your project schedules do not overallocate the projects available resources. Performing resource leveling delays simultaneous activities so that overallocated resources and roles may work on activities consecutively.", "operationId":"/action/level_level", "requestBody":{ "description":"A leveler options object specifying leveling options to use when performing resource leveling.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityLevelerOption", "$ref":"#/components/schemas/ApiEntityLevelerOption", "exampleSetFlag":false }, "examples":{ "Perform_Project_Resource_Leveling":{ "summary":"Perform Project Resource Leveling", "description":"Payload to perform project resource leveling which is a process of analyzing and adjusting resource assignments in a project schedule to ensure that resource demand does not exceed resource availability using workspace code, project code and is leveling method role.", "value":{ "workspaceCode":"Civil_Lines_Project", "projectCode":"JamesStreet", "isLevelingMethodRole":true }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-level-post", "x-filename-id":"action-level-post" } }, "/action/scheduleProject":{ "post":{ "tags":[ "Action" ], "summary":"Schedule a Project", "description":"Send a request to this endpoint to schedule a project. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs.Schedule a project to determine a project timeline based on the constraints, relationships, and date types to which activities must adhere. The application's project scheduler will use the Critical path method algorithm to assign activity dates, calculate total float, and set the project critical path. ", "operationId":"/action/scheduleProject_projectSchedule", "requestBody":{ "description":"A project schedule object specifying a target project and optional data date. ", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectScheduleInput", "$ref":"#/components/schemas/ApiEntityProjectScheduleInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-scheduleProject-post", "x-filename-id":"action-scheduleproject-post" } }, "/action/applyActivityUncertainty/run":{ "post":{ "tags":[ "Action" ], "summary":"Apply Activity Uncertainty", "description":"Send a request to this endpoint to apply activity uncertainty for a project. This endpoint returns a job ID. Send a request to the View Job Status endpoint to view the status of the activity uncertainty job.", "operationId":"/action/applyActivityUncertainty/run_runApplyActivityUncertainty", "requestBody":{ "description":"An object specifying activity uncertainty run settings.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityApplyActivityUncertainty", "$ref":"#/components/schemas/ApiEntityApplyActivityUncertainty", "exampleSetFlag":false }, "examples":{ "Apply_Activity_Uncertainty":{ "summary":"Apply Activity Uncertainty", "description":"Payload to apply activity uncertainty using the distribution shape, workspace code, and project code.", "value":{ "distributionShape":"NONE", "workspaceCode":"Civil_Lines_Project", "projectCode":"JamesStreet" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-applyActivityUncertainty-run-post", "x-filename-id":"action-applyactivityuncertainty-run-post" } }, "/action/report/run":{ "post":{ "tags":[ "Action" ], "summary":"Run a Report", "description":"Send a request to this endpoint to run a report. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs. Reports are user-defined synopses that contain detailed or summarized information about your projects. Reports may be output in a variety of file formats, including PDF, XLS, RTF, HTML, and XML.", "operationId":"/action/report/run_runReport", "requestBody":{ "description":"An object specifying report run settings.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReportOverridesInput", "$ref":"#/components/schemas/ApiEntityReportOverridesInput", "exampleSetFlag":false }, "examples":{ "Run_a_Report":{ "summary":"Run a Report", "description":"Payload to run a report using the report code, workspace ID, and format.", "value":{ "reportCode":"R-8101", "workspaceId":194001, "format":"HTML" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-report-run-post", "x-filename-id":"action-report-run-post" } }, "/action/runRiskAnalysis":{ "post":{ "tags":[ "Action" ], "summary":"Run Risk Analysis", "description":"Send a request to this endpoint to run a risk analysis job. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs. Risk analysis uses project risk data to determine the severity and potential impact of project risks. Run risk analysis on your projects to ascertain the likelihood of achieving your project's cost and schedule objectives.", "operationId":"/action/runRiskAnalysis_runRiskAnalysis", "requestBody":{ "description":"Monte Carlo Settings using which Risk Analysis has to be run.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloSettingsInput", "$ref":"#/components/schemas/ApiEntityMonteCarloSettingsInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-runRiskAnalysis-post", "x-filename-id":"action-runriskanalysis-post" } }, "/action/resourceDemand/fetchAssignment":{ "post":{ "tags":[ "Action" ], "summary":"Create Resource Demand from Schedule", "description":"Send a request to this endpoint to schedule a demand data to fetch from resource assignments.", "operationId":"/action/resourceDemand/fetchAssignment_scheduleDemandDataFetchFromResourceAssignment", "requestBody":{ "description":"An object specifying schedule resource demand settings.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDemandSchedule", "$ref":"#/components/schemas/ApiEntityDemandSchedule", "exampleSetFlag":false }, "examples":{ "Create_Resource_Demand_from_Schedule":{ "summary":"Create Resource Demand from Schedule", "description":"Payload to create a resource demand using the project code, workspace code and keep-existing demands.", "value":{ "projectCode":"JamesStreet", "workspaceCode":"Civil_Lines_Project", "keepExistingDemands":true }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-resourceDemand-fetchAssignment-post", "x-filename-id":"action-resourcedemand-fetchassignment-post" } }, "/action/resource/workRateSync":{ "post":{ "tags":[ "Action" ], "summary":"Synchronize Resource Availabilities and Rates for Workspace Hierarchy", "description":"Send a request to this endpoint to synchronize the resource availabilities and rates in a workspace hierarchy. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of the scheduled jobs. The job will also synchronize role availability and rates if the user has the permission to edit role costs. ", "operationId":"/action/resource/workRateSync_syncResourceWorkRate", "requestBody":{ "description":"Workspace ID for the workspace to synchronize resource availabilities and rates.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkRateSync", "$ref":"#/components/schemas/ApiEntityWorkRateSync", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-resource-workRateSync-post", "x-filename-id":"action-resource-workratesync-post" } }, "/action/role/workRateSync":{ "post":{ "tags":[ "Action" ], "summary":"Synchronize Role Availabilities and Rates for Workspace Hierarchy", "description":"Send a request to this endpoint to synchronize the role availabilities and rates in a workspace hierarchy. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of the scheduled jobs. ", "operationId":"/action/role/workRateSync_syncRoleWorkRate", "requestBody":{ "description":"Workspace ID for the workspace to synchronize role availabilities and rates.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkRateSync", "$ref":"#/components/schemas/ApiEntityWorkRateSync", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-role-workRateSync-post", "x-filename-id":"action-role-workratesync-post" } }, "/activityAggregate/projects":{ "get":{ "tags":[ "Activity Aggregate" ], "summary":"View an Activity Aggregate by Project ", "description":"This endpoint returns activity aggregates that meet the following requirements:
  • The object is associated with a project with an ID value that matches one of the values of the {id} query parameter.
Activity aggregates sum the data of activities that meet specified requirements.", "operationId":"/activityAggregate/projects_loadByProjects", "parameters":[ { "name":"id", "in":"query", "description":"One or more system-generated identifiers of projects.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity aggregate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityAggregate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityAggregate-projects-get", "x-filename-id":"activityaggregate-projects-get" } }, "/activityAggregate/workPackage/project":{ "get":{ "tags":[ "Activity Aggregate" ], "summary":"View a Work Package Activity Aggregate by Projects", "description":"This endpoint returns work package activity aggregates that meet the following requirements:
  • The object is associated with a project with an ID value that matches one of the values of the {id} query parameter.
Activity aggregates sum the data of activities that meet specified requirements.", "operationId":"/activityAggregate/workPackage/project_loadForWorkPackageByProject", "parameters":[ { "name":"id", "in":"query", "description":"The system-generated identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity aggregate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityAggregate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityAggregate-workPackage-project-get", "x-filename-id":"activityaggregate-workpackage-project-get" } }, "/activityAggregate/workPackage/portfolio":{ "get":{ "tags":[ "Activity Aggregate" ], "summary":"View a Work Package Activity Aggregate by Portfolio ", "description":"This endpoint returns work package activity aggregates that meet the following requirements:
  • The object is associated with a portfolio with an ID value that matches one of the values of the {id} query parameter.
Activity aggregates sum the data of activities that meet specified requirements.", "operationId":"/activityAggregate/workPackage/portfolio_loadForWorkPackageByProjectPortfolio", "parameters":[ { "name":"id", "in":"query", "description":"The system-generated identifier of a portfolio.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity aggregate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityAggregate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityAggregate-workPackage-portfolio-get", "x-filename-id":"activityaggregate-workpackage-portfolio-get" } }, "/activity":{ "put":{ "tags":[ "Activity" ], "summary":"Update an Activity", "description":"Send a request to this endpoint to update an activity. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/activity_update", "requestBody":{ "description":"An activity object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityInput", "$ref":"#/components/schemas/ApiEntityActivityInput", "exampleSetFlag":false }, "examples":{ "Update_an_Activity":{ "summary":"Update an Activity", "description":"Payload to update a priority and status using the activity ID.", "value":{ "activityId":3024007, "activityPriority":"HIGH", "activityStatus":"IN_PROGRESS" }, "valueSetFlag":true }, "Update_an_Activity_by_Removing_a_Configured_Field":{ "summary":"Update an Activity by Removing a Configured Field", "description":"Payload to update an activity using the activity ID and specifying the action and column label for the configured field to be removed.", "value":{ "configuredFields":[ { "action":"DELETE", "columnLabel":"ACTIVITY_STARTED" } ], "activityId":236565 }, "valueSetFlag":true }, "Update_an_Activity_Using_Codes":{ "summary":"Update an Activity Using Codes", "description":"Payload to update a priority and status using the activity code, project code, and workspace code.", "value":{ "activityCode":"A1013", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "activityPriority":"TOP", "activityStatus":"IN_PROGRESS" }, "valueSetFlag":true }, "Update_an_Activity_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update an Activity by Assigning Multiple Code Values Using IDs", "description":"Payload to update an activity using the activity ID and codeValuesActivity fields such as code value ID and code type ID.", "value":{ "codeValuesActivity":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "activityId":1236565 }, "valueSetFlag":true }, "Update_an_Activity_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update an Activity by Assigning Code Values Using IDs", "description":"Payload to update an activity using the activity ID and codeValuesActivity fields such as code value ID and code type ID.", "value":{ "codeValuesActivity":[ { "codeTypeId":15, "codeValueId":941941 } ], "activityId":1236565 }, "valueSetFlag":true }, "Update_an_Activity_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update an Activity by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update an activity using the activity ID and codeValuesActivity fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "codeValuesActivity":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "activityId":1236565 }, "valueSetFlag":true }, "Update_an_Activity_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update an Activity by Assigning Code Values Using Codes", "description":"Payload to update an activity using the project code, workspace code, activity code, and codeValuesActivity fields such as code value code and code type code.", "value":{ "codeValuesActivity":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1001" }, "valueSetFlag":true }, "Update_an_Activity_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update an Activity to Assign a Boolean Configured Field", "description":"Payload to update an activity using the activity ID and configured field column label and text value.", "value":{ "configuredFields":[ { "columnLabel":"ACTIVITY_STARTED", "textValue":"Y" } ], "activityId":236565 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"activity-put", "x-filename-id":"activity-put" }, "post":{ "tags":[ "Activity" ], "summary":"Create an Activity", "description":"Send a request to this endpoint to create an activity. An application object will be created using the JSON data provided in the request body.", "operationId":"/activity_create", "requestBody":{ "description":"An activity object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityInput", "$ref":"#/components/schemas/ApiEntityActivityInput", "exampleSetFlag":false }, "examples":{ "Create_an_Activity_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create an Activity by Assigning Multiple Code Values Using IDs", "description":"Payload to create an activity using the project ID, activity code, activity name, and codeValuesActivity fields such as code value ID and code type ID.", "value":{ "codeValuesActivity":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "projectId":2899701, "activityCode":"A1001", "activityName":"Concrete Foundation" }, "valueSetFlag":true }, "Create_an_Activity_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create an Activity by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create an activity using the project code, workspace code, activity code, activity name, and codeValuesActivity fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "codeValuesActivity":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1001", "activityName":"Concrete Foundation" }, "valueSetFlag":true }, "Create_an_Activity_that_includes_Configured_Field_Text":{ "summary":"Create an Activity that includes Configured Field Text", "description":"Payload to create an activity using the project ID, activity code, activity name, and values for the configured field which include column name and text value.", "value":{ "configuredFields":[ { "columnName":"ActivityNotes", "textValue":"Activity is delayed due to some labor problems" } ], "projectId":"2899701", "activityCode":"A1001", "activityName":"Concrete Foundation" }, "valueSetFlag":true }, "Create_an_Activity_Using_Codes":{ "summary":"Create an Activity Using Codes", "description":"Payload to create an activity using the project code, workspace code, activity code, activity name, priority, type, WBS code hierarchy list, planned start, percent complete type, percent complete weighted by, duration type, and calendar name.", "value":{ "activityName":"Roof Slab", "activityCode":"A1013", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "wbscodes":[ "ATP", "Bl-C" ], "activityType":"ACTIVITY", "activityPriority":"NORMAL", "critical":true, "percentCompleteWeightedBy":"COST", "percentCompleteType":"DURATION", "durationType":"FIXED_DURATION", "calendarName":"Default Calendar", "plannedStart":"2023-03-01T08:00:00.+0000" }, "valueSetFlag":true }, "Create_an_Activity_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create an Activity by Assigning Code Values Using IDs", "description":"Payload to create an activity using the project ID, activity code, activity name, and codeValuesActivity fields such as code value ID and code type ID.", "value":{ "codeValuesActivity":[ { "codeTypeId":15, "codeValueId":941941 } ], "projectId":2899701, "activityCode":"A1001", "activityName":"Concrete Foundation" }, "valueSetFlag":true }, "Create_an_Activity":{ "summary":"Create an Activity", "description":"Payload to create an activity using the project ID, activity code, activity name, priority, type, WBS ID, planned start, percent complete type, percent complete weighted by, duration type, and calendar ID.", "value":{ "activityName":"Concrete Foundation", "activityCode":"A1010", "projectId":1888907, "wbsId":2024515, "activityType":"ACTIVITY", "activityPriority":"NORMAL", "critical":true, "percentCompleteWeightedBy":"COST", "percentCompleteType":"DURATION", "durationType":"FIXED_DURATION", "calendar":0, "plannedStart":"2023-03-01T08:00:00.+0000" }, "valueSetFlag":true }, "Create_an_Activity_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create an Activity that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create an activity using the project ID, activity code, activity name, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "configuredFields":[ { "columnName":"ActivityNotes", "textValue":"Activity is delayed due to some labor problems" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ], "projectId":"2899701", "activityCode":"A1001", "activityName":"Concrete Foundation" }, "valueSetFlag":true }, "Create_an_Activity_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create an Activity by Assigning Code Values Using Codes", "description":"Payload to create an activity using the project code, workspace code, activity code, activity name, and codeValuesActivity fields such as code value code and code type code.", "value":{ "codeValuesActivity":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1001", "activityName":"Concrete Foundation" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivity", "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-post", "x-filename-id":"activity-post" } }, "/activity/batch":{ "put":{ "tags":[ "Activity" ], "summary":"Batch Update Activities", "description":"Send a request to this endpoint to update one or more activities. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/activity/batch_updateBatch", "requestBody":{ "description":"One or more activity objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Activities_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Activities by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update activities using the activity ID and codeValuesActivity fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesActivity":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "activityId":436448 }, { "codeValuesActivity":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "activityId":436449 } ], "valueSetFlag":true }, "Batch_Update_Activities":{ "summary":"Batch Update Activities", "description":"Payload to update an priority and status of one or more activities using the activity IDs.", "value":[ { "activityId":3024008, "activityPriority":"HIGH", "activityStatus":"IN_PROGRESS" }, { "activityId":3024009, "activityPriority":"LOW", "activityStatus":"IN_PROGRESS" } ], "valueSetFlag":true }, "Batch_Update_Activities_to_Assign_Configured_Field":{ "summary":"Batch Update Activities to Assign Configured Field", "description":"Payload to update activities using activity ID, and configured field column name, column label, column definition ID, and text value.", "value":[ { "configuredFields":[ { "columnName":"ActivityNotes", "textValue":"Activity is delayed due to some labor problems" }, { "columnDefinationId":60045, "textValue":"N" } ], "activityId":300125 }, { "configuredFields":[ { "columnLabel":"ACTIVITY_NOTES", "textValue":"Activity is delayed due to some labor problems" }, { "columnDefinationId":60045, "textValue":"Y" } ], "activityId":300126 } ], "valueSetFlag":true }, "Batch_Update_Activities_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Activities by Assigning Code Values Using Codes or IDs", "description":"Payload to update activities using the activity ID and codeValuesActivity fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "codeValuesActivity":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "activityId":436446 }, { "codeValuesActivity":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "activityId":436447 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"activity-batch-put", "x-filename-id":"activity-batch-put" }, "post":{ "tags":[ "Activity" ], "summary":"Batch Create Activities", "description":"Send a request to this endpoint to create one or more activities. An application object will be created for each JSON object provided in the request body. ", "operationId":"/activity/batch_createBatch", "requestBody":{ "description":"One or more activity objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Activities":{ "summary":"Batch Create Activities", "description":"Payload to create one or more activities using the activity name, activity code, project ID and wbs ID.", "value":[ { "activityName":"Install Railings Exterior", "activityCode":"IN1011", "projectId":1888907, "wbsId":2024515 }, { "activityName":"Install Railings Interior", "activityCode":"IN1012", "projectId":1888907, "wbsId":2024515 } ], "valueSetFlag":true }, "Batch_Create_Activities_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Activities by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create activities using the project code, workspace code, activity code, activity name, and codeValuesActivity fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesActivity":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1001", "activityName":"Concrete Foundation" }, { "codeValuesActivity":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1002", "activityName":"Concrete Wall" } ], "valueSetFlag":true }, "Batch_Create_Activities_that_include_Configured_Field_Text":{ "summary":"Batch Create Activities that include Configured Field Text", "description":"Payload to create activities using the project code, workspace code, activity code, activity name, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "configuredFields":[ { "columnName":"ActivityNotes", "textValue":"Activity is delayed due to some labor problems" }, { "columnDefinationId":60045, "textValue":"N" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1001", "activityName":"Concrete Foundation" }, { "configuredFields":[ { "columnLabel":"PLANNER_NOTES", "textValue":"Activity is delayed due to lack of Materials" }, { "columnDefinationId":60045, "textValue":"Y" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1002", "activityName":"Concrete Wall" } ], "valueSetFlag":true }, "Batch_Create_Activities_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Activities by Assigning Code Values Using Codes", "description":"Payload to create activities using the project code, workspace code, activity code, activity name, and codeValuesActivity fields such as code value code and code type code.", "value":[ { "codeValuesActivity":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1001", "activityName":"Concrete Foundation" }, { "codeValuesActivity":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1002", "activityName":"Concrete Wall" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-batch-post", "x-filename-id":"activity-batch-post" }, "delete":{ "tags":[ "Activity" ], "summary":"Batch Delete Activities", "description":"Send a request to this endpoint to delete one or more activities. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/activity/batch_deleteBatch", "requestBody":{ "description":"The system-generated identifier of an activity.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"activity-batch-delete", "x-filename-id":"activity-batch-delete" } }, "/activity/{activityId}":{ "get":{ "tags":[ "Activity" ], "summary":"View an Activity", "description":"This endpoint returns activities that meet the following requirements:
  • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
Activities represent units of work that must be completed to accomplish your project objectives.", "operationId":"/activity/{activityId}_find", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"includeBaselineFields", "in":"query", "description":"The Activity baseline fields which user wants to include. Allowed values are ORIGINAL, CURRENT, OTHER, USER_BASELINE_1, USER_BASELINE_2 and USER_BASELINE_3 or any combination.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivity", "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-{activityId}-get", "x-filename-id":"activity-activityid-get" }, "delete":{ "tags":[ "Activity" ], "summary":"Delete an Activity", "description":"Send a request to this endpoint to delete an activity. The application object with an ID value that matches the value of the {activityId} path parameter will be deleted.", "operationId":"/activity/{activityId}_delete", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"activity-{activityId}-delete", "x-filename-id":"activity-activityid-delete" } }, "/activity/byItemCode":{ "get":{ "tags":[ "Activity" ], "summary":"View an Activity by Code and Parent Codes", "description":"Send a request to this endpoint to view an activity with codes matching the code fields in query parameters.", "operationId":"/activity/byItemCode_findActivityByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the activity to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the activity to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityCode", "in":"query", "description":"Activity code of the activity to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeBaselineFields", "in":"query", "description":"The Activity baseline fields which user wants to include. Allowed values are ORIGINAL, CURRENT, OTHER, USER_BASELINE_1, USER_BASELINE_2 and USER_BASELINE_3 or any combination.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivity", "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-byItemCode-get", "x-filename-id":"activity-byitemcode-get" } }, "/activity/code/{activityCode}":{ "get":{ "tags":[ "Activity" ], "summary":"View Activities by Code", "description":"This endpoint returns an activity that meet the following requirements:
  • The object has a code that matches the value of the {activityCode} path parameter.
Activities represent units of work that must be completed to accomplish your project objectives.", "operationId":"/activity/code/{activityCode}_findByCode", "parameters":[ { "name":"activityCode", "in":"path", "description":"The user-specified identifier of an activity.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeBaselineFields", "in":"query", "description":"The Activity baseline fields which user wants to include. Allowed values are ORIGINAL, CURRENT, OTHER, USER_BASELINE_1, USER_BASELINE_2 and USER_BASELINE_3 or any combination.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-code-{activityCode}-get", "x-filename-id":"activity-code-activitycode-get" } }, "/activity/project/{projectId}/code/{activityCode}":{ "get":{ "tags":[ "Activity" ], "summary":"View an Activity by Project and Activity Code", "description":"This endpoint returns activities that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a code that matches the value of the {activityCode} path parameter.
Activities represent units of work that must be completed to accomplish your project objectives.", "operationId":"/activity/project/{projectId}/code/{activityCode}_findByCodeAndProjectId", "parameters":[ { "name":"activityCode", "in":"path", "description":"The user-specified identifier of an activity.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"includeBaselineFields", "in":"query", "description":"The Activity baseline fields which user wants to include. Allowed values are ORIGINAL, CURRENT, OTHER, USER_BASELINE_1, USER_BASELINE_2 and USER_BASELINE_3 or any combination.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-project-{projectId}-code-{activityCode}-get", "x-filename-id":"activity-project-projectid-code-activitycode-get" } }, "/activity/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Activity" ], "summary":"View Activities by Project, Code Type, and Code Value", "description":"This endpoint returns activities that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object is assigned a code type that matches the value of the {codeTypeId} path parameter with a value that matches the value of the {codeValueCode} path parameter.
Activities represent units of work that must be completed to accomplish your project objectives.", "operationId":"/activity/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}_findByCodeValue", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeBaselineFields", "in":"query", "description":"The Activity baseline fields which user wants to include. Allowed values are ORIGINAL, CURRENT, OTHER, USER_BASELINE_1, USER_BASELINE_2 and USER_BASELINE_3 or any combination.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-project-{projectId}-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"activity-project-projectid-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/activity/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Activity" ], "summary":"View Activities by Configured Field", "description":"This endpoint returns activities that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
Activities represent units of work that must be completed to accomplish your project objectives.", "operationId":"/activity/project/{projectId}/configuredField/{viewColumnName}/{value}_findByUDFValue", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeBaselineFields", "in":"query", "description":"The Activity baseline fields which user wants to include. Allowed values are ORIGINAL, CURRENT, OTHER, USER_BASELINE_1, USER_BASELINE_2 and USER_BASELINE_3 or any combination.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"activity-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/activity/project/{projectId}":{ "get":{ "tags":[ "Activity" ], "summary":"View all Activities by Project ", "description":"This endpoint returns activities that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Activities represent units of work that must be completed to accomplish your project objectives.", "operationId":"/activity/project/{projectId}_getActivitiesByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"includeBaselineFields", "in":"query", "description":"The Activity baseline fields which user wants to include. Allowed values are ORIGINAL, CURRENT, OTHER, USER_BASELINE_1, USER_BASELINE_2 and USER_BASELINE_3 or any combination.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-project-{projectId}-get", "x-filename-id":"activity-project-projectid-get" } }, "/activity/byParent":{ "get":{ "tags":[ "Activity" ], "summary":"View all Activities by Parent", "description":"Send a request to this endpoint to view all activities under parent with codes matching the code fields in query parameters.", "operationId":"/activity/byParent_getActivitiesByProjectCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the activities have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code under which all the activities have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeBaselineFields", "in":"query", "description":"The Activity baseline fields which user wants to include. Allowed values are ORIGINAL, CURRENT, OTHER, USER_BASELINE_1, USER_BASELINE_2 and USER_BASELINE_3 or any combination.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-byParent-get", "x-filename-id":"activity-byparent-get" } }, "/activity/notebookTopic/project/{projectId}":{ "get":{ "tags":[ "Activity" ], "summary":"View Activity Notebook Topics", "description":"Send a request to this endpoint to view activity notebook topics for all activities under the project matching the path parameter {projectId}.", "operationId":"/activity/notebookTopic/project/{projectId}_getActivityNotebookTopicsByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-notebookTopic-project-{projectId}-get", "x-filename-id":"activity-notebooktopic-project-projectid-get" } }, "/activity/userBaselinePreferences":{ "get":{ "tags":[ "Activity" ], "summary":"View User Baseline Preferences", "description":"Send a request to this endpoint to view the User Baseline Preferences.", "operationId":"/activity/userBaselinePreferences_getUserBaselinePreferences", "parameters":[ { "name":"userName", "in":"query", "description":"User name of application user.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUserBaseline", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-userBaselinePreferences-get", "x-filename-id":"activity-userbaselinepreferences-get" } }, "/activity/wbsId/{wbsId}":{ "get":{ "tags":[ "Activity" ], "summary":"View Activities by WBS", "description":"This endpoint returns activities that meet the following requirements:
  • The object is associated with a WBS with an ID value that matches the value of the {wbsId} path parameter.
Activities represent units of work that must be completed to accomplish your project objectives.", "operationId":"/activity/wbsId/{wbsId}_getWBSActivities", "parameters":[ { "name":"wbsId", "in":"path", "description":"The system-generated identifier of a WBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"includeBaselineFields", "in":"query", "description":"The Activity baseline fields which user wants to include. Allowed values are ORIGINAL, CURRENT, OTHER, USER_BASELINE_1, USER_BASELINE_2 and USER_BASELINE_3 or any combination.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-wbsId-{wbsId}-get", "x-filename-id":"activity-wbsid-wbsid-get" } }, "/activity/baseline/data":{ "get":{ "tags":[ "Activity" ], "summary":"View Activities by Baseline", "description":"Send a request to this endpoint to view all activities by baseline matching the code fields in query parameters.", "operationId":"/activity/baseline/data_loadActivitiesByBaseline", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"baselineName", "in":"query", "description":"The user-specified identifier of a project baseline.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"baselineType", "in":"query", "description":"Identifies the official and unofficial baselines. Default value is ORIGINAL.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CURRENT", "OTHER", "USER_BASELINE_1", "USER_BASELINE_2", "USER_BASELINE_3" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-baseline-data-get", "x-filename-id":"activity-baseline-data-get" } }, "/activity/scheduleScenario/data":{ "get":{ "tags":[ "Activity" ], "summary":"View Activities by Schedule Scenario", "description":"Send a request to this endpoint to view all activities for the schedule scenario matching the code fields in the query parameters.", "operationId":"/activity/scheduleScenario/data_loadActivitiesByScenario", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenarioName", "in":"query", "description":"The user-specified identifier of a schedule scenario.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-scheduleScenario-data-get", "x-filename-id":"activity-schedulescenario-data-get" } }, "/activity/syncBatch":{ "post":{ "tags":[ "Activity" ], "summary":"Batch Sync Activities", "description":"Send a request to this endpoint to create or update one or more activities.", "operationId":"/activity/syncBatch_syncBatch", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any activity sent as part of the request.
Allowed Values: [ \"true\", \"false\" ].", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more activity objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_an_Activities_Using_Codes":{ "summary":"Create or Update an Activities Using Codes", "description":"Payload to create or update one or more activities using the project code, workspace code, activity code, activity name, priority, type, WBS code hierarchy list, planned start, percent complete type, percent complete weighted by, duration type, and calendar name.", "value":[ { "activityName":"Roof Slab", "activityCode":"A1013", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "wbscodes":[ "ATP", "Bl-C" ], "activityType":"ACTIVITY", "activityPriority":"NORMAL", "critical":true, "percentCompleteWeightedBy":"COST", "percentCompleteType":"DURATION", "durationType":"FIXED_DURATION", "calendarName":"Default Calendar", "plannedStart":"2023-03-01T08:00:00.+0000" } ], "valueSetFlag":true }, "Create_or_Update_Activities_to_Assign_a_Configured_Field":{ "summary":"Create or Update Activities to Assign a Configured Field", "description":"Payload to create or update activities using the project code, workspace code, activity code, activity name, activity ID, and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "configuredFields":[ { "columnLabel":"ACTIVITY_NOTES", "textValue":"Activity is delayed due to some labor problems" }, { "columnDefinationId":60145, "textValue":"Y" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1001", "activityName":"Concrete Foundation" }, { "configuredFields":[ { "columnLabel":"ACTIVITY_NOTES", "textValue":"Activity is delayed due to weather problems" }, { "columnDefinationId":60245, "numberValue":2 } ], "activityId":"244756" } ], "valueSetFlag":true }, "Create_or_Update_Activities_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create or Update Activities by Assigning Code Values Using Codes", "description":"Payload to create or update activities using the project code, workspace code, activity code, activity name, activity ID, and codeValuesActivity fields such as code value code and code type code.", "value":[ { "codeValuesActivity":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1001", "activityName":"Concrete Foundation" }, { "codeValuesActivity":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "activityId":244756 } ], "valueSetFlag":true }, "Create_or_Update_Activities_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create or Update Activities by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update activities using the project code, workspace code, activity code, activity name, activity ID, and codeValuesActivity fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesActivity":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "activityCode":"A1001", "activityName":"Concrete Foundation" }, { "codeValuesActivity":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "activityId":244756 } ], "valueSetFlag":true }, "Create_or_Update_an_Activities":{ "summary":"Create or Update an Activities", "description":"Payload to create or update one or more activities using the project ID, activity code, activity name, priority, type, WBS ID, planned start, percent complete type, percent complete weighted by, duration type, and calendar ID.", "value":[ { "activityName":"Concrete Foundation", "activityCode":"A1010", "projectId":1888907, "wbsId":2024515, "activityType":"ACTIVITY", "activityPriority":"NORMAL", "critical":true, "percentCompleteWeightedBy":"COST", "percentCompleteType":"DURATION", "durationType":"FIXED_DURATION", "calendar":0, "plannedStart":"2023-03-01T08:00:00.+0000" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activity-syncBatch-post", "x-filename-id":"activity-syncbatch-post" } }, "/activityFavorite":{ "post":{ "tags":[ "Activity Favorite" ], "summary":"Create an Activity Favorite", "description":"Send a request to this endpoint to create an activity favorite. An application object will be created using the JSON data provided in the request body.", "operationId":"/activityFavorite_create_1", "requestBody":{ "description":"An activity favorite object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityFavoriteInput", "$ref":"#/components/schemas/ApiEntityActivityFavoriteInput", "exampleSetFlag":false }, "examples":{ "Create_an_Activity_Favorate_Using_Codes":{ "summary":"Create an Activity_Favourate Using Codes", "description":"Create an activity favorite using the activity code, project code, workspace code, and username.", "value":{ "activityCode":"IN1011", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "userName":"admin@stable3a.foo" }, "valueSetFlag":true }, "Create_an_Activity_Favorite":{ "summary":"Create an Activity Favorite", "description":"Create an activity favorite using the activity ID and user ID.", "value":{ "activity":3024007, "applicationUser":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Favorite service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityFavorite", "$ref":"#/components/schemas/ApiEntityActivityFavorite", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"activityFavorite-post", "x-filename-id":"activityfavorite-post" } }, "/activityFavorite/batch":{ "post":{ "tags":[ "Activity Favorite" ], "summary":"Batch Create Activity Favorites", "description":"Send a request to this endpoint to create one or more activity favorites. An application object will be created for each JSON object provided in the request body.", "operationId":"/activityFavorite/batch_createBatch_1", "requestBody":{ "description":"One or more activity favorite objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityFavoriteInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Activity_Favorites":{ "summary":"Batch Create Activity Favorites", "description":"Create one or more activity favorites using the activity IDs and the user IDs.", "value":[ { "activity":3024009, "applicationUser":10001 }, { "activity":3024013, "applicationUser":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Favorite service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityFavorite", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityFavorite-batch-post", "x-filename-id":"activityfavorite-batch-post" }, "delete":{ "tags":[ "Activity Favorite" ], "summary":"Batch Delete Activity Favorites", "description":"Send a request to this endpoint to delete one or more activity favorites. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/activityFavorite/batch_deleteBatch_1", "requestBody":{ "description":"The system-generated identifier of an activity favorite.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Favorite service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"activityFavorite-batch-delete", "x-filename-id":"activityfavorite-batch-delete" } }, "/activityFavorite/{activityFavoriteId}":{ "get":{ "tags":[ "Activity Favorite" ], "summary":"View an Activity Favorite", "description":"This endpoint returns activity favorites that meet the following requirements:
  • The object has an activity favorite ID that matches the value of the {activityFavoriteId} path parameter.
", "operationId":"/activityFavorite/{activityFavoriteId}_find_1", "parameters":[ { "name":"activityFavoriteId", "in":"path", "description":"The system-generated identifier of an activity favorite.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity favorite does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityFavorite", "$ref":"#/components/schemas/ApiEntityActivityFavorite", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"activityFavorite-{activityFavoriteId}-get", "x-filename-id":"activityfavorite-activityfavoriteid-get" }, "delete":{ "tags":[ "Activity Favorite" ], "summary":"Delete an Activity Favorite", "description":"Send a request to this endpoint to delete an activity favorite. The application object with an ID value that matches the value of the {activityFavoriteId} path parameter will be deleted.", "operationId":"/activityFavorite/{activityFavoriteId}_delete_1", "parameters":[ { "name":"activityFavoriteId", "in":"path", "description":"The system-generated identifier of an activity favorite.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Activity Favorite service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"activityFavorite-{activityFavoriteId}-delete", "x-filename-id":"activityfavorite-activityfavoriteid-delete" } }, "/activityFavorite/userId/{applicationUser}":{ "get":{ "tags":[ "Activity Favorite" ], "summary":"View Activity Favorites by User", "description":"This endpoint returns all activity favorites that meet the following requirements:
  • The object is associated with an application user with an ID value that matches the value of the {applicationUser} path parameter.
", "operationId":"/activityFavorite/userId/{applicationUser}_findAllByUser", "parameters":[ { "name":"applicationUser", "in":"path", "description":"The system-generated identifier of an application user.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity favorite does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityFavorite", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityFavorite-userId-{applicationUser}-get", "x-filename-id":"activityfavorite-userid-applicationuser-get" } }, "/activityFavorite/userId/{applicationUser}/activityId/{activity}":{ "get":{ "tags":[ "Activity Favorite" ], "summary":"View an Activity Favorite by User and Activity", "description":"This endpoint returns all activity favorites that meet the following requirements:
  • The object is associated with an application user with an ID value that matches the value of the {applicationUser} path parameter.
  • The object is associated with an activity with an ID value that matches the value of the {activity} path parameter.
", "operationId":"/activityFavorite/userId/{applicationUser}/activityId/{activity}_findByUserAndId", "parameters":[ { "name":"applicationUser", "in":"path", "description":"The system-generated identifier of an application user.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"activity", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity favorite does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityFavorite", "$ref":"#/components/schemas/ApiEntityActivityFavorite", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"activityFavorite-userId-{applicationUser}-activityId-{activity}-get", "x-filename-id":"activityfavorite-userid-applicationuser-activityid-activity-get" } }, "/activityFavorite/itemCode":{ "get":{ "tags":[ "Activity Favorite" ], "summary":"View an Activity Favorite by Code and Parent Codes", "description":"Send a request to this endpoint to view an activity favorite with codes matching the code fields in query parameters.", "operationId":"/activityFavorite/itemCode_getActivityFavoriteByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityCode", "in":"query", "description":"The user-specified identifier of an activity.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"userName", "in":"query", "description":"User name of application user.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityFavorite", "$ref":"#/components/schemas/ApiEntityActivityFavorite", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"activityFavorite-itemCode-get", "x-filename-id":"activityfavorite-itemcode-get" } }, "/activityFavorite/parentCode":{ "get":{ "tags":[ "Activity Favorite" ], "summary":"View All Activity Favorites by Parent", "description":"Send a request to this endpoint to view all activity favorites under parent with codes matching the code fields in query parameters.", "operationId":"/activityFavorite/parentCode_getAllActivityFavoriteByParent", "parameters":[ { "name":"userName", "in":"query", "description":"User name of application user.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity favorite does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityFavorite", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityFavorite-parentCode-get", "x-filename-id":"activityfavorite-parentcode-get" } }, "/activityRisk":{ "put":{ "tags":[ "Activity Risk" ], "summary":"Update an Activity Risk", "description":"Send a request to this endpoint to update an activity risk. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/activityRisk_update_1", "requestBody":{ "description":"An activity risk object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityRiskInput", "$ref":"#/components/schemas/ApiEntityActivityRiskInput", "exampleSetFlag":false }, "examples":{ "Update_an_Activity_Risk_Using_Activity_Risk_ID":{ "summary":"Update an Activity Risk Using Activity Risk ID", "description":"Payload to update the quantified other impacts of an activity risk using the activity risk ID.", "value":{ "activityRiskId":64103, "quantifiedOtherImpacts":[ { "maximum":40, "minimum":0, "shape":"UNIFORM", "scoreType":"SCHEDULE", "preOrPostResponse":"PRE_RESPONSE" }, { "maximum":80, "minimum":40, "shape":"UNIFORM", "scoreType":"SCHEDULE", "preOrPostResponse":"POST_RESPONSE" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Risk service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"activityRisk-put", "x-filename-id":"activityrisk-put" }, "post":{ "tags":[ "Activity Risk" ], "summary":"Create an Activity Risk", "description":"Send a request to this endpoint to create an activity risk. An application object will be created using the JSON data provided in the request body.", "operationId":"/activityRisk_create_2", "requestBody":{ "description":"An activity risk object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityRiskInput", "$ref":"#/components/schemas/ApiEntityActivityRiskInput", "exampleSetFlag":false }, "examples":{ "Create_an_Activity_Risk":{ "summary":"Create an Activity Risk", "description":"Payload to assign a risk to an activity using the activity ID, and project risk ID.", "value":{ "activityId":78101, "projectRiskId":72101 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Risk service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityRisk", "$ref":"#/components/schemas/ApiEntityActivityRisk", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"activityRisk-post", "x-filename-id":"activityrisk-post" } }, "/activityRisk/batch":{ "put":{ "tags":[ "Activity Risk" ], "summary":"Batch Update Activity Risks", "description":"Send a request to this endpoint to update one or more activity risks. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/activityRisk/batch_updateBatch_1", "requestBody":{ "description":"One or more activity risk objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Activity_Risks_Using_Activity_Risk_IDs":{ "summary":"Batch Update Activity Risks Using Activity Risk IDs", "description":"Payload to update the quantified other impacts of one or more activity risks using the activity risk ID.", "value":[ { "activityRiskId":64103, "quantifiedOtherImpacts":[ { "maximum":40, "minimum":0, "shape":"UNIFORM", "scoreType":"SCHEDULE", "preOrPostResponse":"PRE_RESPONSE" }, { "maximum":80, "minimum":40, "shape":"UNIFORM", "scoreType":"SCHEDULE", "preOrPostResponse":"POST_RESPONSE" } ] }, { "activityRiskId":64104, "quantifiedOtherImpacts":[ { "maximum":120, "minimum":80, "shape":"UNIFORM", "scoreType":"SCHEDULE", "preOrPostResponse":"PRE_RESPONSE" }, { "maximum":40, "minimum":24, "shape":"UNIFORM", "scoreType":"SCHEDULE", "preOrPostResponse":"POST_RESPONSE" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Risk service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"activityRisk-batch-put", "x-filename-id":"activityrisk-batch-put" }, "post":{ "tags":[ "Activity Risk" ], "summary":"Batch Create Activity Risks", "description":"Send a request to this endpoint to create one or more activity risks. An application object will be created for each JSON object provided in the request body.", "operationId":"/activityRisk/batch_createBatch_2", "requestBody":{ "description":"One or more activity risk objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Activity_Risks":{ "summary":"Batch Create Activity Risks", "description":"Payload to create one or more activity risks using the activity IDs and project risk IDs.", "value":[ { "activityId":78101, "projectRiskId":72101 }, { "activityId":78102, "projectRiskId":72101 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Risk service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityRisk-batch-post", "x-filename-id":"activityrisk-batch-post" }, "delete":{ "tags":[ "Activity Risk" ], "summary":"Batch Delete Activity Risks", "description":"Send a request to this endpoint to delete one or more activity risks. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/activityRisk/batch_deleteBatch_2", "requestBody":{ "description":"One or more system-generated identifiers of activity risks.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Risk service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"activityRisk-batch-delete", "x-filename-id":"activityrisk-batch-delete" } }, "/activityRisk/{activityRiskId}":{ "get":{ "tags":[ "Activity Risk" ], "summary":"View an Activity Risk", "description":"This endpoint returns activity risks that meet the following requirements:
  • The object has an activity risk ID that matches the value of the {activityRiskId} path parameter.
Activity Risks indicate whether risks from the project risk register will impact a project activity and potentially cause schedule delays.", "operationId":"/activityRisk/{activityRiskId}_find_2", "parameters":[ { "name":"activityRiskId", "in":"path", "description":"The system-generated identifier of an activity risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity risk does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityActivityRisk", "$ref":"#/components/schemas/ApiEntityActivityRisk", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"activityRisk-{activityRiskId}-get", "x-filename-id":"activityrisk-activityriskid-get" }, "delete":{ "tags":[ "Activity Risk" ], "summary":"Delete an Activity Risk", "description":"Send a request to this endpoint to delete an activity risk. The application object with an ID value that matches the value of the {activityRiskId} path parameter will be deleted.", "operationId":"/activityRisk/{activityRiskId}_delete_2", "parameters":[ { "name":"activityRiskId", "in":"path", "description":"The system-generated identifier of an activity risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Activity Risk service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"activityRisk-{activityRiskId}-delete", "x-filename-id":"activityrisk-activityriskid-delete" } }, "/activityRisk/activity/{activityId}":{ "get":{ "tags":[ "Activity Risk" ], "summary":"View all Activity Risks by Activity", "description":"This endpoint returns activity risks that meet the following requirements:
  • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
Activity Risks indicate whether risks from the project risk register will impact a project activity and potentially cause schedule delays.", "operationId":"/activityRisk/activity/{activityId}_findActivityRiskByActivity", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity risk does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityRisk-activity-{activityId}-get", "x-filename-id":"activityrisk-activity-activityid-get" } }, "/activityRisk/project/{projectId}":{ "get":{ "tags":[ "Activity Risk" ], "summary":"View all Activity Risks by Project ID", "description":"This endpoint returns activity risks that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/activityRisk/project/{projectId}_findActivityRiskByProjectId", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity risk does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityRisk-project-{projectId}-get", "x-filename-id":"activityrisk-project-projectid-get" } }, "/activityRisk/projectRisk/{projectRiskId}":{ "get":{ "tags":[ "Activity Risk" ], "summary":"View all Activity Risks by Project Risk ID", "description":"This endpoint returns activity risks that meet the following requirements:
  • The object is associated with a project risk with an ID value that matches the value of the {projectRiskId} path parameter.
", "operationId":"/activityRisk/projectRisk/{projectRiskId}_findActivityRiskByProjectRiskId", "parameters":[ { "name":"projectRiskId", "in":"path", "description":"The system-generated identifier of a project risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity risk does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityRisk-projectRisk-{projectRiskId}-get", "x-filename-id":"activityrisk-projectrisk-projectriskid-get" } }, "/activityRisk/syncBatch":{ "post":{ "tags":[ "Activity Risk" ], "summary":"Batch Sync Activity Risks", "description":"Send a request to this endpoint to create or update one or more activity risks.", "operationId":"/activityRisk/syncBatch_syncBatch_1", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any activity risk sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more activity risk objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Activity_Risks_using_Codes":{ "summary":"Create or Update Activity Risks using Codes", "description":"Payload to create or update activity risks using the activity code, risk code, project code, and workspace code.", "value":[ { "activityCode":"A1010", "riskCode":"R1", "projectCode":"New Town - City Mall", "workspaceCode":"North America" } ], "valueSetFlag":true }, "Create_or_Update_Activity_Risks_using_Impacts":{ "summary":"Create or Update Activity Risks using Impacts", "description":"Payload to create or update activity risks using the activity ID, project risk ID, and impacts, such as maximum, minimum, score type, shape, and pre- or post-response.", "value":[ { "activityId":50001, "projectRiskId":48001, "quantifiedOtherImpacts":[ { "maximum":15, "minimum":10, "scoreType":"SCHEDULE", "shape":"UNIFORM", "preOrPostResponse":"PRE_RESPONSE" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Risk service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"activityRisk-syncBatch-post", "x-filename-id":"activityrisk-syncbatch-post" } }, "/util/testConnection":{ "get":{ "tags":[ "Util" ], "summary":"Test API Connection", "description":"Send a request to this end point for testing the rest api connection. Status code 200 is returned in case the connection is successful.", "operationId":"/util/testConnection_testConnection", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityTestConnectionResponse", "$ref":"#/components/schemas/ApiEntityTestConnectionResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"util-testConnection-get", "x-filename-id":"util-testconnection-get" } }, "/applicationUserGroup":{ "put":{ "tags":[ "Application User Group" ], "summary":"Update a User Group ", "description":"Send a request to this endpoint to update a user group.", "operationId":"/applicationUserGroup_update_2", "requestBody":{ "description":"A user group object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityApplicationUserGroupInput", "$ref":"#/components/schemas/ApiEntityApplicationUserGroupInput", "exampleSetFlag":false }, "examples":{ "Update_an_User_Group":{ "summary":"Update a User Group", "description":"Update a user group using the application user Group ID, group name, LDAP ID, scope, scope ID, and workspace ID.", "value":{ "applicationUserGroupId":20301, "groupName":"Design Team", "ldapGuid":2, "scope":"WORKSPACE", "scopeId":10001, "workspaceId":1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the user group service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"applicationUserGroup-put", "x-filename-id":"applicationusergroup-put" }, "post":{ "tags":[ "Application User Group" ], "summary":"Create a User Group", "description":"Send a request to this endpoint to create a user group.", "operationId":"/applicationUserGroup_create_3", "requestBody":{ "description":"A user group object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityApplicationUserGroupInput", "$ref":"#/components/schemas/ApiEntityApplicationUserGroupInput", "exampleSetFlag":false }, "examples":{ "Create_an_User_group":{ "summary":"Create a User Group", "description":"Payload to create a user group using the group name, LDAP ID, scope, scope ID, and workspace ID.", "value":{ "groupName":"Design Team", "ldapGuid":12, "scope":"WORKSPACE", "scopeId":10001, "workspaceId":1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the user group service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityApplicationUserGroup", "$ref":"#/components/schemas/ApiEntityApplicationUserGroup", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"applicationUserGroup-post", "x-filename-id":"applicationusergroup-post" } }, "/applicationUserGroup/batch":{ "put":{ "tags":[ "Application User Group" ], "summary":"Batch Update User Groups", "description":"Send a request to this endpoint to update one or more user groups.", "operationId":"/applicationUserGroup/batch_updateBatch_2", "requestBody":{ "description":"One or more user group objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserGroupInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_User_Groups":{ "summary":"Batch Update User Groups", "description":"Update one or more user groups using the application user group ID, group name, LDAP ID, scope, scope ID, and workspace ID.", "value":[ { "applicationUserGroupId":20302, "groupName":"Architects", "ldapGuid":10, "scope":"WORKSPACE", "scopeId":10001, "workspaceId":1 }, { "applicationUserGroupId":20303, "groupName":"Mechanical", "ldapGuid":2, "scope":"WORKSPACE", "scopeId":10001, "workspaceId":1 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the user group service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"applicationUserGroup-batch-put", "x-filename-id":"applicationusergroup-batch-put" }, "post":{ "tags":[ "Application User Group" ], "summary":"Batch Create User Groups", "description":"Send a request to this endpoint to create one or more user groups.", "operationId":"/applicationUserGroup/batch_createBatch_3", "requestBody":{ "description":"One or more user group objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserGroupInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_User_Groups":{ "summary":"Batch Create User Groups", "description":"Payload to create one or more user groups using the group name, LDAP ID, scope, scope ID, and workspace ID.", "value":[ { "groupName":"Architects", "ldapGuid":12, "scope":"WORKSPACE", "scopeId":10001, "workspaceId":1 }, { "groupName":"Mechanical", "ldapGuid":10, "scope":"WORKSPACE", "scopeId":10001, "workspaceId":1 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the user group service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserGroup", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"applicationUserGroup-batch-post", "x-filename-id":"applicationusergroup-batch-post" } }, "/applicationUserGroup/{applicationUserGroupId}":{ "get":{ "tags":[ "Application User Group" ], "summary":"View a User Group", "description":"This endpoint returns user groups that meet the following requirements:
  • The object has an user group ID that matches the value of the {applicationUserGroupId} path parameter.
", "operationId":"/applicationUserGroup/{applicationUserGroupId}_find_3", "parameters":[ { "name":"applicationUserGroupId", "in":"path", "description":"The system-generated identifier of a user group.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested user group does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityApplicationUserGroup", "$ref":"#/components/schemas/ApiEntityApplicationUserGroup", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"applicationUserGroup-{applicationUserGroupId}-get", "x-filename-id":"applicationusergroup-applicationusergroupid-get" } }, "/applicationUserGroup/groupName/{groupName}":{ "get":{ "tags":[ "Application User Group" ], "summary":"View a User Group by Group Name", "description":"This endpoint returns user groups whose group name matches the value of the {groupName} path parameter.", "operationId":"/applicationUserGroup/groupName/{groupName}_findByGroupName", "parameters":[ { "name":"groupName", "in":"path", "description":"The name of a user group.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested user group does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserGroup", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"applicationUserGroup-groupName-{groupName}-get", "x-filename-id":"applicationusergroup-groupname-groupname-get" } }, "/applicationUserGroup/syncBatch":{ "post":{ "tags":[ "Application User Group" ], "summary":"Batch Sync Application User Groups", "description":"Send a request to this endpoint to create or update one or more application user groups.", "operationId":"/applicationUserGroup/syncBatch_syncBatch_2", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any application user group sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more user group objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserGroupInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Application_User_Groups_for_a_Workspace":{ "summary":"Create or Update Application User Groups for a Workspace", "description":"Payload to create or update the application user groups using the group name, scope, and workspace ID.", "value":[ { "groupName":"Architects", "scope":"WORKSPACE", "workspaceId":14001 } ], "valueSetFlag":true }, "Create_or_Update_Application_User_Groups_for_a_Project":{ "summary":"Create or Update Application User Groups for a Project", "description":"Payload to create or update the application user groups using the group name, scope, and workspace ID.", "value":[ { "groupName":"Mechanical", "scope":"PROJECT", "workspaceCode":"North America", "scopeCode":"New Town - City Mall" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the user group service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"applicationUserGroup-syncBatch-post", "x-filename-id":"applicationusergroup-syncbatch-post" } }, "/userPreferences/{applicationUserSettingId}":{ "get":{ "tags":[ "User Preferences" ], "summary":"View User Preferences", "description":"This endpoint returns user preferences that meet the following requirements:
  • The object has an application user setting ID that matches the value of the {applicationUserSettingId} path parameter.
", "operationId":"/userPreferences/{applicationUserSettingId}_find_4", "parameters":[ { "name":"applicationUserSettingId", "in":"path", "description":"The system-generated identifier of user preferences.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested user preferences object does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityApplicationUserSetting", "$ref":"#/components/schemas/ApiEntityApplicationUserSetting", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"userPreferences-{applicationUserSettingId}-get", "x-filename-id":"userpreferences-applicationusersettingid-get" } }, "/userPreferences/name/{settingName}":{ "get":{ "tags":[ "User Preferences" ], "summary":"View User Preferences by Setting Name", "description":"This endpoint returns user preferences that meet the following requirements:
  • The object has a setting name that matches the value of the {settingName} path parameter.
", "operationId":"/userPreferences/name/{settingName}_findByName", "parameters":[ { "name":"settingName", "in":"path", "description":"The name of a user preference. ", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ActivitiesViewSettings", "ActivityNetworkSettings", "ReportsSummaryGridViewConfig", "DecimalPlaces", "NumberDecimalPlaces", "CurrencySymbol", "FourDigitYear", "LeadingZeros", "MonthName", "Separator", "DateFormat", "DigitGroupingSeparator", "DecimalSeparator", "DigitGroupingAndDecimalSymbols", "DigitGroupingStyle", "CurrencyNegativeFormat", "CurrencyPositiveFormat", "TabOrder", "AppVisibilityAndOrder", "ProjectCodesViewConfig", "ProfileImage", "ReportColWidth", "ReportScheduleColWidth", "ScheduleColWidth", "WorkspaceAndProjectDisplayFormat", "CodeValueDisplayFormat", "AnnouncementsLastReadTime", "LocationsViewConfig", "workflowTasksPrefs", "WorkflowViewLogViewConfig", "monitorWorkflowsPrefs", "startWorkflowsPrefs", "workflowDesignsPrefs", "workflowConfigsPrefs", "monitorWorkflowTasksPrefs", "formTemplatesPrefs", "formPreviewPrefs", "userDashboardPref", "SearchAll", "SearchWorkspaces", "SearchProjects", "SearchScopeItems", "SearchProjectCodes", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "SearchIdeas", "SearchPrograms", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "DataDateInPageBanners", "ActualDateIndicator", "ConstraintDateIndicator", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "WhenResourceAndRoleShareActivityAssignment", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions", "HomeRecentsVisible", "UserFirstName", "UserLastName", "UserTitle", "UserLocale", "UserAlternateEmail", "UserPhoneNumber", "UserMobileNumber", "UserFaxNumber", "UserDisplayDensity", "UserTimeZone", "OnboardedForVersion", "WorkPlanGettingStartedShown", "CookiesAcknowledged", "PlaAccepted", "LastSearchIndexRequest", "displayScheduleLog", "LastAccessedWorkPackageId", "LastSearchIndexCompleted", "ExperimentalEnhancedPrint", "ExperimentalColumnMenu", "AutoSaveNamedViews" ] } } ], "responses":{ "404":{ "description":"The requested user preferences object does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityApplicationUserSetting", "$ref":"#/components/schemas/ApiEntityApplicationUserSetting", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"userPreferences-name-{settingName}-get", "x-filename-id":"userpreferences-name-settingname-get" } }, "/userPreferences/applicablePreferenceValues":{ "get":{ "tags":[ "User Preferences" ], "summary":"View the applicable values for user preferences", "description":"Send a request to this endpoint to return the applicable values for the fields in user preferences.", "operationId":"/userPreferences/applicablePreferenceValues_getAllowedUserPreferenceValues", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicablePreferenceValues", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"userPreferences-applicablePreferenceValues-get", "x-filename-id":"userpreferences-applicablepreferencevalues-get" } }, "/userPreferences/allUserSettings":{ "get":{ "tags":[ "User Preferences" ], "summary":"View All User Preferences", "description":"This endpoint returns all user preferences.", "operationId":"/userPreferences/allUserSettings_getUserPreferences", "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"userPreferences-allUserSettings-get", "x-filename-id":"userpreferences-allusersettings-get" } }, "/userPreferences/syncBatch":{ "post":{ "tags":[ "User Preferences" ], "summary":"Batch Sync User Preferences", "description":"Send a request to this endpoint to create or update one or more user preference.", "operationId":"/userPreferences/syncBatch_syncBatch_3", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any user preference sent as part of the request.
Allowed Values: [ \"true\", \"false\" ].", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"A user preferences object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserSettingInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the User Preference service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"userPreferences-syncBatch-post", "x-filename-id":"userpreferences-syncbatch-post" } }, "/userPreferences":{ "put":{ "tags":[ "User Preferences" ], "summary":"Update a User's Preferences (Deprecated since 25.5)", "description":"Send a request to this endpoint to update a user's preferences.", "operationId":"/userPreferences_update_3", "requestBody":{ "description":"A user preferences object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityApplicationUserSettingInput", "$ref":"#/components/schemas/ApiEntityApplicationUserSettingInput", "exampleSetFlag":false }, "examples":{ "Update_a_User's_Preferences":{ "summary":"Update a User's Preferences", "description":"Payload to update the setting value of a user preference using the application user ID, application user setting ID, and setting name.", "value":{ "applicationUserId":10001, "applicationUserSettingId":12243, "settingName":"DisplayUnits", "settingValue":"d" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the user preferences service." }, "204":{ "description":"Successful operation with no content." } }, "deprecated":true, "x-internal-id":"userPreferences-put", "x-filename-id":"userpreferences-put" } }, "/userPreferences/batch":{ "put":{ "tags":[ "User Preferences" ], "summary":"Batch Update User Preferences (Deprecated since 25.5)", "description":"Send a request to this endpoint to update one or more user preferences.", "operationId":"/userPreferences/batch_updateBatch_3", "requestBody":{ "description":"A user preferences object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserSettingInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_User_Preferences":{ "summary":"Batch Update User Preferences", "description":"Payload to update the setting value of one or more user preferences using the application user IDs, application user setting IDs, and setting names.", "value":[ { "applicationUserId":10001, "applicationUserSettingId":12243, "settingName":"DisplayUnits", "settingValue":"d" }, { "applicationUserId":10001, "applicationUserSettingId":12244, "settingName":"DisplayDuration", "settingValue":"h" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the user preferences service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "deprecated":true, "x-internal-id":"userPreferences-batch-put", "x-filename-id":"userpreferences-batch-put" } }, "/assignment":{ "put":{ "tags":[ "Assignment" ], "summary":"Update an Assignment", "description":"Send a request to this endpoint to update an assignment. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/assignment_update_4", "requestBody":{ "description":"An assignment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityAssignmentInput", "$ref":"#/components/schemas/ApiEntityAssignmentInput", "exampleSetFlag":false }, "examples":{ "Update_an_Assignment_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update an Assignment to Assign a Boolean Configured Field", "description":"Payload to update an assignment using an assignment ID and configured field column label and text value.", "value":{ "assignmentId":"834111", "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_an_Assignment_Using_Assignment_Code":{ "summary":"Update an Assignment Using Assignment Code", "description":"Payload to update an assignment using an activity ID and a resource ID.", "value":{ "assignmentCode":"AA1", "activityId":834001, "resourceId":324101 }, "valueSetFlag":true }, "Update_an_Assignment_by_Removing_a_Configured_Field":{ "summary":"Update an Assignment by Removing a Configured Field", "description":"Payload to update an assignment using an assignment ID and and specifying the action and column label for the configured field to be removed.", "value":{ "assignmentId":"834111", "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Assignment service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"assignment-put", "x-filename-id":"assignment-put" }, "post":{ "tags":[ "Assignment" ], "summary":"Create an Assignment", "description":"Send a request to this endpoint to create an assignment. An application object will be created using the JSON data provided in the request body.", "operationId":"/assignment_create_4", "requestBody":{ "description":"An assignment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityAssignmentInput", "$ref":"#/components/schemas/ApiEntityAssignmentInput", "exampleSetFlag":false }, "examples":{ "Create_an_Assignment_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create an Assignment that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create an assignment using an activity ID, resource ID and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "assignmentCode":"AA2", "activityId":834001, "resourceId":324101, "configuredFields":[ { "columnName":"Notes", "textValue":"Resource R1 assigned for an activity A1" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_an_Assignment_that_includes_Configured_Field_Text":{ "summary":"Create an Assignment that includes Configured Field Text", "description":"Payload to create an assignment using an activity ID, resource ID and values for the configured field which include column name and text value.", "value":{ "assignmentCode":"AA2", "activityId":834001, "resourceId":324101, "configuredFields":[ { "columnName":"Notes", "textValue":"Resource assigned for an activity" } ] }, "valueSetFlag":true }, "Create_an_Assignment":{ "summary":"Create an Assignment", "description":"Payload to create an assignment using an activity ID and a resource ID.", "value":{ "assignmentCode":"AA1", "activityId":834001, "resourceId":324101 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Assignment service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityAssignment", "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-post", "x-filename-id":"assignment-post" } }, "/assignment/batch":{ "put":{ "tags":[ "Assignment" ], "summary":"Batch Update Assignments", "description":"Send a request to this endpoint to update one or more assignments. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/assignment/batch_updateBatch_4", "requestBody":{ "description":"One or more assignment objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Assignments_Using_Assignment_Codes":{ "summary":"Batch Update Assignments Using Assignment Codes", "description":"Payload to update one or more assignments using activity IDs and resource IDs.", "value":[ { "assignmentCode":"AA1", "activityId":834001, "resourceId":324101 }, { "assignmentCode":"AA2", "activityId":834001, "resourceId":324102 } ], "valueSetFlag":true }, "Batch_Update_Assignments_to_Assign_Configured_Field":{ "summary":"Batch Update Assignments to Assign Configured Field", "description":"Payload to update one or more assignments using assignment ID and configured field column name, column label, column definition ID, and text value.", "value":[ { "assignmentId":"20098", "configuredFields":[ { "columnName":"Notes", "textValue":"Resource R1 assigned for an activity A1" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "assignmentId":"20099", "configuredFields":[ { "columnName":"Notes", "textValue":"Resource R2 assigned for an activity A2" }, { "columnDefinationId":60045, "textValue":"N" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Assignment service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"assignment-batch-put", "x-filename-id":"assignment-batch-put" }, "post":{ "tags":[ "Assignment" ], "summary":"Batch Create Assignments", "description":"Send a request to this endpoint to create one or more assignments. An application object will be created for each JSON object provided in the request body.", "operationId":"/assignment/batch_createBatch_4", "requestBody":{ "description":"One or more assignment objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Assignments":{ "summary":"Batch Create Assignments", "description":"Payload to create one or more assignments using an activity ID and a resource ID.", "value":[ { "assignmentCode":"AA1", "activityId":834001, "resourceId":324101 }, { "assignmentCode":"AA2", "activityId":834001, "resourceId":324102 } ], "valueSetFlag":true }, "Batch_Create_Assignments_that_include_Configured_Field_Text":{ "summary":"Batch Create Assignments that include Configured Field Text", "description":"Payload to create one or more assignments using an activity ID, resource ID, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "assignmentCode":"AA1", "activityId":834001, "resourceId":324101, "configuredFields":[ { "columnName":"Notes", "textValue":"Resource R1 assigned for an activity A1" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "assignmentCode":"AA2", "activityId":834001, "resourceId":324102, "configuredFields":[ { "columnName":"Notes", "textValue":"Resource R2 assigned for an activity A2" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Assignment service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-batch-post", "x-filename-id":"assignment-batch-post" }, "delete":{ "tags":[ "Assignment" ], "summary":"Batch Delete Assignments", "description":"Send a request to this endpoint to delete one or more assignments. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/assignment/batch_deleteBatch_3", "requestBody":{ "description":"One or more system-generated identifiers of assignments.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Assignment service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"assignment-batch-delete", "x-filename-id":"assignment-batch-delete" } }, "/assignment/{assignmentId}":{ "get":{ "tags":[ "Assignment" ], "summary":"View an Assignment", "description":"This endpoint returns assignments that meet the following requirements:
  • The object is associated with an assignment with an ID value that matches the value of the {assignmentId} path parameter.
Assignments represent the allocation of project or workspace resources to project activities.", "operationId":"/assignment/{assignmentId}_find_5", "parameters":[ { "name":"assignmentId", "in":"path", "description":"The system-generated identifier of an assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested assignment does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityAssignment", "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-{assignmentId}-get", "x-filename-id":"assignment-assignmentid-get" }, "delete":{ "tags":[ "Assignment" ], "summary":"Delete an Assignment", "description":"Send a request to this endpoint to delete an assignment. The application object with an ID value that matches the value of the {assignmentId} path parameter will be deleted.", "operationId":"/assignment/{assignmentId}_delete_3", "parameters":[ { "name":"assignmentId", "in":"path", "description":"The system-generated identifier of an assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Assignment service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"assignment-{assignmentId}-delete", "x-filename-id":"assignment-assignmentid-delete" } }, "/assignment/code/{assignmentCode}":{ "get":{ "tags":[ "Assignment" ], "summary":"View Assignments by Code", "description":"This endpoint returns assignments that meet the following requirements:
  • The object has a code that matches the value of the {assignmentCode} path parameter.
Assignments represent the allocation of project or workspace resources to project activities.", "operationId":"/assignment/code/{assignmentCode}_findByCode_1", "parameters":[ { "name":"assignmentCode", "in":"path", "description":"The user-specified identifier of an assignment.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-code-{assignmentCode}-get", "x-filename-id":"assignment-code-assignmentcode-get" } }, "/assignment/activity/{activityId}/code/{assignmentCode}":{ "get":{ "tags":[ "Assignment" ], "summary":"View an Assignment by Activity and Code", "description":"This endpoint returns assignments that meet the following requirements:
  • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
  • The object has a code that matches the value of the {assignmentCode} path parameter.
Assignments represent the allocation of project or workspace resources to project activities.", "operationId":"/assignment/activity/{activityId}/code/{assignmentCode}_findByCodeAndActivity", "parameters":[ { "name":"assignmentCode", "in":"path", "description":"The user-specified identifier of an assignment.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-activity-{activityId}-code-{assignmentCode}-get", "x-filename-id":"assignment-activity-activityid-code-assignmentcode-get" } }, "/assignment/project/{projectId}":{ "get":{ "tags":[ "Assignment" ], "summary":"View all Assignments by Project ", "description":"This endpoint returns assignments associated with a project with an ID value that matches the {projectId} path parameter.", "operationId":"/assignment/project/{projectId}_findByProjectId", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-project-{projectId}-get", "x-filename-id":"assignment-project-projectid-get" } }, "/assignment/resource/code/{resourceCode}":{ "get":{ "tags":[ "Assignment" ], "summary":"View Assignments by Resource Code", "description":"This endpoint returns assignements that meet the following requirements:
  • The object has a resource with a code value that matches the value of the {resourceCode} path parameter.
Assignments represent the allocation of project or workspace resources to project activities.", "operationId":"/assignment/resource/code/{resourceCode}_findByResourceCode", "parameters":[ { "name":"resourceCode", "in":"path", "description":"The user-specified identifier of a resource.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-resource-code-{resourceCode}-get", "x-filename-id":"assignment-resource-code-resourcecode-get" } }, "/assignment/resource/{resourceId}":{ "get":{ "tags":[ "Assignment" ], "summary":"View Assignments by Resource", "description":"This endpoint returns assignments that meet the following requirements:
  • The object has a resource with an ID value that matches the value of the {resourceId} path parameter.
Assignments represent the allocation of project or workspace resources to project activities.", "operationId":"/assignment/resource/{resourceId}_findByResourceId", "parameters":[ { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-resource-{resourceId}-get", "x-filename-id":"assignment-resource-resourceid-get" } }, "/assignment/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Assignment" ], "summary":"View Assignments by Configured Field Values", "description":"This endpoint returns assignments that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
Assignments represent the allocation of project or workspace resources to project activities.", "operationId":"/assignment/project/{projectId}/configuredField/{viewColumnName}/{value}_findByUDFValue_1", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"assignment-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/assignment/activityId/{activityId}":{ "get":{ "tags":[ "Assignment" ], "summary":"View Assignments by Activity ", "description":"This endpoint returns assignments that meet the following requirements:
  • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
Assignments represent the allocation of project or workspace resources to project activities.", "operationId":"/assignment/activityId/{activityId}_getActivityAssignments", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-activityId-{activityId}-get", "x-filename-id":"assignment-activityid-activityid-get" } }, "/assignment/baseline/data":{ "get":{ "tags":[ "Assignment" ], "summary":"View Assignments by Baseline", "description":"Send a request to this endpoint to view all assignments by baseline matching the code fields in query parameters.", "operationId":"/assignment/baseline/data_loadAssignmentsByBaseline", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"baselineName", "in":"query", "description":"The user-specified identifier of a project baseline.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"baselineType", "in":"query", "description":"Identifies the official and unofficial baselines. Default value is ORIGINAL.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CURRENT", "OTHER", "USER_BASELINE_1", "USER_BASELINE_2", "USER_BASELINE_3" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-baseline-data-get", "x-filename-id":"assignment-baseline-data-get" } }, "/assignment/scheduleScenario/data":{ "get":{ "tags":[ "Assignment" ], "summary":"View Assignments by Schedule Scenario", "description":"Send a request to this endpoint to view all assignments for the schedule scenario matching the code fields in the query parameters.", "operationId":"/assignment/scheduleScenario/data_loadAssignmentsByScenario", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenarioName", "in":"query", "description":"The user-specified identifier of a schedule scenario.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-scheduleScenario-data-get", "x-filename-id":"assignment-schedulescenario-data-get" } }, "/assignment/syncBatch":{ "post":{ "tags":[ "Assignment" ], "summary":"Batch Sync Assignments", "description":"Send a request to this endpoint to create or update one or more assignments.", "operationId":"/assignment/syncBatch_syncBatch_4", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any assignment sent as part of the request.
Allowed Values: [ \"true\", \"false\" ].", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more assignment objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_an_Assignment_Using_Codes":{ "summary":"Create or Update an Assignment Using Codes", "description":"Payload to create or update an assignment using an activity code, project code, workspace code, resource code and resource class.", "value":[ { "activityCode":"A1013", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "resourceCode":"R101", "resourceClass":"RESOURCE", "assignmentCode":"AA1" } ], "valueSetFlag":true }, "Create_or_Update_an_Assignments_to_Assign_a_Configured_Field":{ "summary":"Create or Update an Assignment to Assign a Configured Field", "description":"Payload to create or update an assignment using an activity code, project code, workspace code, resource code, resource class, assignment ID, and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "activityCode":"A1013", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "resourceCode":"R101", "resourceClass":"RESOURCE", "assignmentCode":"AA1", "configuredFields":[ { "columnLabel":"Notes", "textValue":"Resource R2 assigned for an activity A2" }, { "columnDefinationId":61045, "textValue":"N" } ] }, { "assignmentId":"20099", "configuredFields":[ { "columnLabel":"Notes", "textValue":"Resource R2 assigned for an activity A2" }, { "columnDefinationId":60045, "numberValue":2 } ] } ], "valueSetFlag":true }, "Create_or_Update_an_Assignment":{ "summary":"Create or Update an Assignment", "description":"Payload to create or update an assignment using an activity ID and a resource ID.", "value":[ { "assignmentCode":"AA1", "activityId":834001, "resourceId":324101 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Assignment service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignment-syncBatch-post", "x-filename-id":"assignment-syncbatch-post" } }, "/assignmentFavorite":{ "post":{ "tags":[ "Assignment Favorite" ], "summary":"Create an Assignment Favorite", "description":"Send a request to this endpoint to create an assignment favorite. An application object will be created using the JSON data provided in the request body.", "operationId":"/assignmentFavorite_create_5", "requestBody":{ "description":"An assignment favorite object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityAssignmentFavoriteInput", "$ref":"#/components/schemas/ApiEntityAssignmentFavoriteInput", "exampleSetFlag":false }, "examples":{ "Create_an_Assignment_Favorite":{ "summary":"Create an Assignment Favorite", "description":"Payload to create an assignment favorite using an application user and an assignment ID.", "value":{ "applicationUser":10001, "assignmentId":278106 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Assignment Favorite service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityAssignmentFavorite", "$ref":"#/components/schemas/ApiEntityAssignmentFavorite", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"assignmentFavorite-post", "x-filename-id":"assignmentfavorite-post" } }, "/assignmentFavorite/batch":{ "post":{ "tags":[ "Assignment Favorite" ], "summary":"Batch Create Assignment Favorites", "description":"Send a request to this endpoint to create one or more assignment favorites. An application object will be created for each JSON object provided in the request body.", "operationId":"/assignmentFavorite/batch_createBatch_5", "requestBody":{ "description":"One or more assignment favorite objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentFavoriteInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Assignment_Favorites":{ "summary":"Batch Create Assignment Favorites", "description":"Payload to create one or more assignment favorites using application users and assignment IDs.", "value":[ { "applicationUser":10001, "assignmentId":278106 }, { "applicationUser":10001, "assignmentId":278105 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Assignment Favorite service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentFavorite", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignmentFavorite-batch-post", "x-filename-id":"assignmentfavorite-batch-post" }, "delete":{ "tags":[ "Assignment Favorite" ], "summary":"Batch Delete Assignment Favorites", "description":"Send a request to this endpoint to delete one or more assignment favorites. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/assignmentFavorite/batch_deleteBatch_4", "requestBody":{ "description":"One or more system-generated identifiers of assignment favorites.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Assignment Favorite service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"assignmentFavorite-batch-delete", "x-filename-id":"assignmentfavorite-batch-delete" } }, "/assignmentFavorite/{assignmentFavoriteId}":{ "get":{ "tags":[ "Assignment Favorite" ], "summary":"View an Assignment Favorite", "description":"This endpoint returns assignment favorites that meet the following requirements:
  • The object is associated with an assignment favorite with an ID value that matches the value of the {assignmentFavoriteId} path parameter.
Assignment favorites represent assignments that you consider particularly important.", "operationId":"/assignmentFavorite/{assignmentFavoriteId}_find_6", "parameters":[ { "name":"assignmentFavoriteId", "in":"path", "description":"The system-generated identifier of an assignment favorite.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested assignment favorite does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityAssignmentFavorite", "$ref":"#/components/schemas/ApiEntityAssignmentFavorite", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"assignmentFavorite-{assignmentFavoriteId}-get", "x-filename-id":"assignmentfavorite-assignmentfavoriteid-get" }, "delete":{ "tags":[ "Assignment Favorite" ], "summary":"Delete an Assignment Favorite ", "description":"Send a request to this endpoint to delete an assignment favorite. The application object with an ID value that matches the value of the {assignmentFavoriteId} path parameter will be deleted.", "operationId":"/assignmentFavorite/{assignmentFavoriteId}_delete_4", "parameters":[ { "name":"assignmentFavoriteId", "in":"path", "description":"The system-generated identifier of an assignment favorite.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Assignment Favorite service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"assignmentFavorite-{assignmentFavoriteId}-delete", "x-filename-id":"assignmentfavorite-assignmentfavoriteid-delete" } }, "/assignmentFavorite/userId/{applicationUser}":{ "get":{ "tags":[ "Assignment Favorite" ], "summary":"View all Assignment Favorites Assigned to a User", "description":"This endpoint returns assignment favorites that meet the following requirements:
  • The object is associated with an application user with an ID value that matches the value of the {applicationUser} path parameter.
Assignment favorites represent assignments that you consider particularly important.", "operationId":"/assignmentFavorite/userId/{applicationUser}_findAllByUser_1", "parameters":[ { "name":"applicationUser", "in":"path", "description":"The system-generated identifier of an application user.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested assignment favorite does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentFavorite", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignmentFavorite-userId-{applicationUser}-get", "x-filename-id":"assignmentfavorite-userid-applicationuser-get" } }, "/assignmentFavorite/userId/{applicationUser}/assignmentId/{assignmentId}":{ "get":{ "tags":[ "Assignment Favorite" ], "summary":"View an Assignment Favorite by User and Assignment ", "description":"This endpoint returns assignment favorites that meet the following requirements:
  • The object is associated with an application user with an ID value that matches the value of the {applicationUser} path parameter.
  • The object is associated with an assignment with an ID value that matches the value of the {assignmentId} path parameter.
Assignment favorites represent assignments that you consider particularly important.", "operationId":"/assignmentFavorite/userId/{applicationUser}/assignmentId/{assignmentId}_findByUserAndId_1", "parameters":[ { "name":"applicationUser", "in":"path", "description":"The system-generated identifier of an application user.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"assignmentId", "in":"path", "description":"The system-generated identifier of an assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested assignment favorite does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityAssignmentFavorite", "$ref":"#/components/schemas/ApiEntityAssignmentFavorite", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"assignmentFavorite-userId-{applicationUser}-assignmentId-{assignmentId}-get", "x-filename-id":"assignmentfavorite-userid-applicationuser-assignmentid-assignmentid-get" } }, "/assignmentFavorite/parentCode":{ "get":{ "tags":[ "Assignment Favorite" ], "summary":"View All Assignment Favorites by Parent", "description":"Send a request to this endpoint to view all assignment favorites under parent with codes matching the code fields in query parameters.", "operationId":"/assignmentFavorite/parentCode_getAllAssignmentFavoriteByParent", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityCode", "in":"query", "description":"The user-specified identifier of an activity.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"userName", "in":"query", "description":"User name of application user.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested assignment favorite does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentFavorite", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"assignmentFavorite-parentCode-get", "x-filename-id":"assignmentfavorite-parentcode-get" } }, "/assignmentFavorite/itemCode":{ "get":{ "tags":[ "Assignment Favorite" ], "summary":"View an Assignment Favorite by Code and Parent Codes", "description":"Send a request to this endpoint to view an assignment favorite with codes matching the code fields in query parameters.", "operationId":"/assignmentFavorite/itemCode_getAssignmentFavoriteByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityCode", "in":"query", "description":"The user-specified identifier of an activity.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"userName", "in":"query", "description":"User name of application user.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"resourceCode", "in":"query", "description":"The user-specified identifier of a resource.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityAssignmentFavorite", "$ref":"#/components/schemas/ApiEntityAssignmentFavorite", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"assignmentFavorite-itemCode-get", "x-filename-id":"assignmentfavorite-itemcode-get" } }, "/baselineCategory":{ "put":{ "tags":[ "Baseline Category" ], "summary":"Update a Baseline Category", "description":"Send a request to this endpoint to update a baseline category. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/baselineCategory_update_5", "requestBody":{ "description":"A baseline category object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaselineCategoryInput", "$ref":"#/components/schemas/ApiEntityBaselineCategoryInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Baseline Category service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"baselineCategory-put", "x-filename-id":"baselinecategory-put" }, "post":{ "tags":[ "Baseline Category" ], "summary":"Create a Baseline Category", "description":"Send a request to this endpoint to create a baseline category. An application object will be created using the JSON data provided in the request body.", "operationId":"/baselineCategory_create_6", "requestBody":{ "description":"A baseline category object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaselineCategoryInput", "$ref":"#/components/schemas/ApiEntityBaselineCategoryInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Baseline Category service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaselineCategory", "$ref":"#/components/schemas/ApiEntityBaselineCategory", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"baselineCategory-post", "x-filename-id":"baselinecategory-post" } }, "/baselineCategory/batch":{ "put":{ "tags":[ "Baseline Category" ], "summary":"Batch Update Baseline Categories", "description":"Send a request to this endpoint to update one or more baseline categories. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/baselineCategory/batch_updateBatch_5", "requestBody":{ "description":"One or more baseline category objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineCategoryInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Baseline Category service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"baselineCategory-batch-put", "x-filename-id":"baselinecategory-batch-put" }, "post":{ "tags":[ "Baseline Category" ], "summary":"Batch Create Baseline Categories", "description":"Send a request to this endpoint to create one or more baseline categories. An application object will be created for each JSON object provided in the request body.", "operationId":"/baselineCategory/batch_createBatch_6", "requestBody":{ "description":"One or more baseline category objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineCategoryInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Baseline Category service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"baselineCategory-batch-post", "x-filename-id":"baselinecategory-batch-post" }, "delete":{ "tags":[ "Baseline Category" ], "summary":"Batch Delete Baseline Categories", "description":"Send a request to this endpoint to delete one or more baseline categories. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/baselineCategory/batch_deleteBatch_5", "requestBody":{ "description":"IDs of the baseline categories to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Baseline Category service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"baselineCategory-batch-delete", "x-filename-id":"baselinecategory-batch-delete" } }, "/baselineCategory/{baselineCategoryId}":{ "get":{ "tags":[ "Baseline Category" ], "summary":"View a Baseline Category", "description":"This endpoint returns baseline categories that meet the following requirements:
  • The object has an ID that matches the value of the {baselineCategoryId} path parameter.
", "operationId":"/baselineCategory/{baselineCategoryId}_find_7", "parameters":[ { "name":"baselineCategoryId", "in":"path", "description":"The system-generated identifier of a baseline category.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested baseline category does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaselineCategory", "$ref":"#/components/schemas/ApiEntityBaselineCategory", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"baselineCategory-{baselineCategoryId}-get", "x-filename-id":"baselinecategory-baselinecategoryid-get" }, "delete":{ "tags":[ "Baseline Category" ], "summary":"Delete a Baseline Category", "description":"Send a request to this endpoint to delete a baseline category. The application object with an ID value that matches the value of the {baselineCategoryId} path parameter will be deleted.", "operationId":"/baselineCategory/{baselineCategoryId}_delete_5", "parameters":[ { "name":"baselineCategoryId", "in":"path", "description":"The system-generated identifier of a baseline category.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Baseline Category service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"baselineCategory-{baselineCategoryId}-delete", "x-filename-id":"baselinecategory-baselinecategoryid-delete" } }, "/baselineCategory/name/{baselineCategoryName}":{ "get":{ "tags":[ "Baseline Category" ], "summary":"View all Baseline Categories by Code", "description":"This endpoint returns baseline categories that meet the following requirements:
  • The object has a name that matches the value of the {baselineCategoryName} path parameter.
", "operationId":"/baselineCategory/name/{baselineCategoryName}_findByCode_2", "parameters":[ { "name":"baselineCategoryName", "in":"path", "description":"The user-specified name of a baseline category.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested baseline category does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"baselineCategory-name-{baselineCategoryName}-get", "x-filename-id":"baselinecategory-name-baselinecategoryname-get" } }, "/baselineCategory/workspace/{workspaceId}":{ "get":{ "tags":[ "Baseline Category" ], "summary":"View all Baseline Categories by Workspace ID", "description":"This endpoint returns baseline categories that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/baselineCategory/workspace/{workspaceId}_getBaselineCategorysByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested baseline category does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"baselineCategory-workspace-{workspaceId}-get", "x-filename-id":"baselinecategory-workspace-workspaceid-get" } }, "/baselineCategory/syncBatch":{ "post":{ "tags":[ "Baseline Category" ], "summary":"Batch Sync Baseline Categories", "description":"Send a request to this endpoint to create or update one or more baseline categories.", "operationId":"/baselineCategory/syncBatch_syncBatch_5", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any baseline category sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more baseline category objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineCategoryInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Baseline Category service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"baselineCategory-syncBatch-post", "x-filename-id":"baselinecategory-syncbatch-post" } }, "/budgetChange/{id}/changeBudgetChangeStatus":{ "put":{ "tags":[ "Project Budget Change" ], "summary":"Change Project Budget Change Status", "description":"Send a request to this endpoint to modify the status of a project budget change.", "operationId":"/budgetChange/{id}/changeBudgetChangeStatus_changeBudgetChangeStatus", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a budget change.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"A new status for the project budget change.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStatusTransition", "$ref":"#/components/schemas/ApiEntityStatusTransition", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "400":{ "description":"Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetChange-{id}-changeBudgetChangeStatus-put", "x-filename-id":"budgetchange-id-changebudgetchangestatus-put" } }, "/budgetChange":{ "put":{ "tags":[ "Project Budget Change" ], "summary":"Update a Project Budget Change", "description":"Send a request to this endpoint to update a project budget change. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/budgetChange_update_6", "requestBody":{ "description":"A budget change object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetChangeInput", "$ref":"#/components/schemas/ApiEntityBudgetChangeInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Budget_Change_the_Using_Budget_Change_ID":{ "summary":"Update a Project Budget Change Using the Budget Change ID", "description":"Payload to update the amount cost project of a project budget change using the budget change ID and budget transaction ID.", "value":{ "budgetChangeId":134105, "budgetTransactions":[ { "budgetTransactionId":484214, "budgetTransactionCost":{ "amountCostProject":200000 } } ] }, "valueSetFlag":true }, "Update_a_Project_Budget_Change_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Project Budget Change to Assign a Boolean Configured Field", "description":"Payload to update the amount cost project of a project budget change using the budget change ID, budget transaction ID, and configured field column label and text value.", "value":{ "budgetChangeId":134105, "budgetTransactions":[ { "budgetTransactionId":484214, "budgetTransactionCost":{ "amountCostProject":200000 } } ], "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Project_Budget_Change_by_Removing_a_Configured_Field":{ "summary":"Update a Project Budget Change by Removing a Configured Field", "description":"Payload to update the amount cost project of a project budget change using the budget change ID, budget transaction ID, and specifying the action and column label for the configured field to be removed", "value":{ "budgetChangeId":134105, "budgetTransactions":[ { "budgetTransactionId":484214, "budgetTransactionCost":{ "amountCostProject":200000 } } ], "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetChange-put", "x-filename-id":"budgetchange-put" }, "post":{ "tags":[ "Project Budget Change" ], "summary":"Create a Project Budget Change", "description":"Send a request to this endpoint to create a project budget change. An application object will be created using the JSON data provided in the request body.", "operationId":"/budgetChange_create_7", "requestBody":{ "description":"A budget change object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetChangeInput", "$ref":"#/components/schemas/ApiEntityBudgetChangeInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Budget_Change_Using_an_Existing_Budget_Item":{ "summary":"Create a Project Budget Change Using an Existing Budget Item", "description":"Payload to create a project budget change of an existing budget item using the budget change code, budget item ID, amount cost project, and project ID.", "value":{ "budgetChangeCode":"Construction Materials Change", "budgetTransactions":[ { "budgetItemId":438202, "budgetTransactionCost":{ "amountCostProject":200000 } } ], "projectId":1656810 }, "valueSetFlag":true }, "Create_a_Project_Budget_Change_Using_a_New_Budget_Item":{ "summary":"Create a Project Budget Change Using a New Budget Item", "description":"Payload to create a project budget change for adding a new budget item using the budget change code, budget item name, desired code, amount cost project, budget CBS sheet code ID, and project ID.", "value":{ "budgetChangeCode":"External Labor Change", "budgetTransactions":[ { "budgetTransactionCost":{ "amountCostProject":100000 }, "budgetItemName":"External Labor", "desiredCode":"External Labor", "budgetCbsSheetCodeId":1947503 } ], "projectId":1656810 }, "valueSetFlag":true }, "Create_a_Project_Budget_Change_that_includes_Configured_Field_Text":{ "summary":"Create a Project Budget Change that includes Configured Field Text", "description":"Payload to create a project budget change of an existing budget item using the budget change code, budget item ID, amount cost project, project ID, and values for the configured field which include column name and text value for budget transactions and budget change", "value":{ "budgetChangeCode":"Construction Materials Change", "budgetTransactions":[ { "budgetItemId":508201, "budgetTransactionCost":{ "amountCostProject":200000 }, "configuredFields":[ { "columnName":"Notes-trans", "textValue":"project Budget transaction Notes" } ] } ], "configuredFields":[ { "columnName":"Notes-Change", "textValue":"project Budget change Notes" } ], "projectId":1220801 }, "valueSetFlag":true }, "Create_a_Project_Budget_Change_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Project Budget Change that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a project budget change of an existing budget item using the budget change code, budget item ID, amount cost project, project ID, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "budgetChangeCode":"Construction Materials Change", "budgetTransactions":[ { "budgetItemId":438202, "budgetTransactionCost":{ "amountCostProject":200000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget change Notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ], "projectId":1656810 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetChange", "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-post", "x-filename-id":"budgetchange-post" } }, "/budgetChange/batch":{ "put":{ "tags":[ "Project Budget Change" ], "summary":"Batch Update Project Budget Changes", "description":"Send a request to this endpoint to update one or more project budget changes. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/budgetChange/batch_updateBatch_6", "requestBody":{ "description":"One or more budget change objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Budget_Changes_Using_the_Budget_Change_IDs":{ "summary":"Batch Update Project Budget Changes Using the Budget Change IDs", "description":"Payload to update the amount cost project of one or more project budget changes using budget change IDs and budget transaction IDs.", "value":[ { "budgetChangeId":134105, "budgetTransactions":[ { "budgetTransactionId":484214, "budgetTransactionCost":{ "amountCostProject":250000 } } ] }, { "budgetChangeId":134106, "budgetTransactions":[ { "budgetTransactionId":484215, "budgetTransactionCost":{ "amountCostProject":350000 } } ] } ], "valueSetFlag":true }, "Batch_Update_Project_Budget_Changes_to_Assign_Configured_Field":{ "summary":"Batch Update Project Budget Changes to Assign Configured Field", "description":"Payload to update the amount cost project of one or more project budget changes using budget change IDs, budget transaction IDs and configured field column name, column label, column definition ID, and text value.", "value":[ { "budgetChangeId":134105, "budgetTransactions":[ { "budgetTransactionId":484214, "budgetTransactionCost":{ "amountCostProject":250000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget change Notes - Budg1" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "budgetChangeId":134106, "budgetTransactions":[ { "budgetTransactionId":484215, "budgetTransactionCost":{ "amountCostProject":350000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget change Notes - Budg2" }, { "columnDefinationId":60045, "textValue":"N" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"budgetChange-batch-put", "x-filename-id":"budgetchange-batch-put" }, "post":{ "tags":[ "Project Budget Change" ], "summary":"Batch Create Project Budget Changes", "description":"Send a request to this endpoint to create one or more project budget changes. An application object will be created for each JSON object provided in the request body.", "operationId":"/budgetChange/batch_createBatch_7", "requestBody":{ "description":"One or more budget change objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Budget_Changes_that_include_Configured_Field_Text":{ "summary":"Batch Create Project Budget Changes that include Configured Field Text", "description":"Payload to create one or more project budget changes using the budget change codes, budget item IDs, amount cost projects, project budget IDs, project IDs and and values for the configured field which include column name, column definition ID, text value.", "value":[ { "budgetChangeCode":"Construction Materials Change", "budgetTransactions":[ { "budgetItemId":438202, "budgetTransactionCost":{ "amountCostProject":200000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget change Notes - Budg1" }, { "columnDefinationId":60045, "textValue":"N" } ], "projectId":1656810 }, { "budgetChangeCode":"Internal Labor Change", "budgetTransactions":[ { "budgetItemId":438202, "budgetTransactionCost":{ "amountCostProject":300000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget change Notes - Budg2" }, { "columnDefinationId":60045, "textValue":"Y" } ], "projectId":1656810 } ], "valueSetFlag":true }, "Batch_Create_Project_Budget_Changes":{ "summary":"Batch Create Project Budget Changes", "description":"Payload to create one or more project budget changes using the budget change codes, budget item IDs, amount cost projects, project budget IDs, and project IDs.", "value":[ { "budgetChangeCode":"Construction Materials Change", "budgetTransactions":[ { "budgetItemId":438202, "budgetTransactionCost":{ "amountCostProject":200000 } } ], "projectBudgetId":1766710, "projectId":1656810 }, { "budgetChangeCode":"Internal Labor Change", "budgetTransactions":[ { "budgetItemId":438202, "budgetTransactionCost":{ "amountCostProject":300000 } } ], "projectBudgetId":1766710, "projectId":1656810 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-batch-post", "x-filename-id":"budgetchange-batch-post" }, "delete":{ "tags":[ "Project Budget Change" ], "summary":"Batch Delete Project Budget Changes", "description":"Send a request to this endpoint to delete one or more project budget changes. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/budgetChange/batch_deleteBatch_6", "requestBody":{ "description":"One or more system-generated identifiers of budget changes.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetChange-batch-delete", "x-filename-id":"budgetchange-batch-delete" } }, "/budgetChange/{budgetChangeId}":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View a Project Budget Change", "description":"This endpoint returns project budget changes that meet the following requirements:
  • The object is associated with a project budget change with an ID value that matches the value of the {budgetChangeId} path parameter.
Budget changes represent modifications or adjustments to project budgets.", "operationId":"/budgetChange/{budgetChangeId}_find_8", "parameters":[ { "name":"budgetChangeId", "in":"path", "description":"The system-generated identifier of a budget change.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetChange", "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-{budgetChangeId}-get", "x-filename-id":"budgetchange-budgetchangeid-get" }, "delete":{ "tags":[ "Project Budget Change" ], "summary":"Delete a Project Budget Change", "description":"Send a request to this endpoint to delete a project budget change. The application object with an ID value that matches the value of the {budgetChangeId} path parameter will be deleted.", "operationId":"/budgetChange/{budgetChangeId}_delete_6", "parameters":[ { "name":"budgetChangeId", "in":"path", "description":"The system-generated identifier of a budget change.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetChange-{budgetChangeId}-delete", "x-filename-id":"budgetchange-budgetchangeid-delete" } }, "/budgetChange/projectBudget/{projectBudgetId}/code/{budgetChangeCode}":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View a Project Budget Change by Code and Project Budget", "description":"This endpoint returns project budget changes that meet the following requirements:
  • The object has a code that matches the value of the {budgetChangeCode} path parameter.
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
Budget changes represent modifications or adjustments to project budgets.", "operationId":"/budgetChange/projectBudget/{projectBudgetId}/code/{budgetChangeCode}_findByCodeAndProjectBudgetId", "parameters":[ { "name":"budgetChangeCode", "in":"path", "description":"The item code of a budget change.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-projectBudget-{projectBudgetId}-code-{budgetChangeCode}-get", "x-filename-id":"budgetchange-projectbudget-projectbudgetid-code-budgetchangecode-get" } }, "/budgetChange/project/{projectId}/code/{budgetChangeCode}":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View a Project Budget Change by Code and Project", "description":"This endpoint returns project budget changes that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a code that matches the value of the {budgetChangeCode} path parameter.
Budget changes represent modifications or adjustments to project budgets.", "operationId":"/budgetChange/project/{projectId}/code/{budgetChangeCode}_findByCodeAndProjectId_1", "parameters":[ { "name":"budgetChangeCode", "in":"path", "description":"The item code of a budget change.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-project-{projectId}-code-{budgetChangeCode}-get", "x-filename-id":"budgetchange-project-projectid-code-budgetchangecode-get" } }, "/budgetChange/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View a Project Budget Change by Project and Assigned Configured Field", "description":"This endpoint returns project budget changes that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
Budget changes represent modifications or adjustments to project budgets.", "operationId":"/budgetChange/project/{projectId}/configuredField/{viewColumnName}/{value}_findByProjectAndUDFValue", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"budgetchange-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/budgetChange/projectBudget/{projectBudgetId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View a Project Budget Change by Project Budget and Assigned Configured Field", "description":"This endpoint returns project budget changes that meet the following requirements:
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
Budget changes represent modifications or adjustments to project budgets.", "operationId":"/budgetChange/projectBudget/{projectBudgetId}/configuredField/{viewColumnName}/{value}_findByProjectBudgetAndUDFValue", "parameters":[ { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-projectBudget-{projectBudgetId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"budgetchange-projectbudget-projectbudgetid-configuredfield-viewcolumnname-value-get" } }, "/budgetChange/{budgetChangeId}/statusTransitionHistory":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View Status Transition History Record by Project Budget Change", "description":"This endpoint returns status transition histories of project budget changes that meet the following requirements:
  • The object is associated with a project budget change with an ID value that matches the value of the {budgetChangeId} path parameter.
Budget changes represent modifications or adjustments to project budgets.", "operationId":"/budgetChange/{budgetChangeId}/statusTransitionHistory_findTransitionHistoryByBudgetChangeId", "parameters":[ { "name":"budgetChangeId", "in":"path", "description":"The system-generated identifier of a budget change.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested status transition history record does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-{budgetChangeId}-statusTransitionHistory-get", "x-filename-id":"budgetchange-budgetchangeid-statustransitionhistory-get" } }, "/budgetChange/project/{projectId}/statusTransitionHistory":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View Status Transition History Record by Project", "description":"This endpoint returns status transition histories of project budget changes that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Budget changes represent modifications or adjustments to project budgets.", "operationId":"/budgetChange/project/{projectId}/statusTransitionHistory_findTransitionHistoryByProjectId", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested status transition history record does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-project-{projectId}-statusTransitionHistory-get", "x-filename-id":"budgetchange-project-projectid-statustransitionhistory-get" } }, "/budgetChange/byParent":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View all Project Budget Changes by Parent", "description":"Send a request to this endpoint to view all project budget changes under parent with codes matching the code fields in query parameters.", "operationId":"/budgetChange/byParent_getAllBudgetChangeByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the budget changes have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code under which all the budget changes have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-byParent-get", "x-filename-id":"budgetchange-byparent-get" } }, "/budgetChange/byItemCode":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View a Project Budget Change by Code and Parent Codes", "description":"Send a request to this endpoint to view a project budget change with codes matching the code fields in query parameters.", "operationId":"/budgetChange/byItemCode_getBudgetChangeByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the budget change to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the budget change to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"budgetChangeCode", "in":"query", "description":"The item code of a budget change.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetChange", "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-byItemCode-get", "x-filename-id":"budgetchange-byitemcode-get" } }, "/budgetChange/project/{projectId}":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View Project Budget Changes by Project", "description":"This endpoint returns project budget changes that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Budget changes represent modifications or adjustments to project budgets.", "operationId":"/budgetChange/project/{projectId}_getBudgetChangesByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-project-{projectId}-get", "x-filename-id":"budgetchange-project-projectid-get" } }, "/budgetChange/projectBudget/{projectBudgetId}":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View Project Budget Changes by Project Budget", "description":"This endpoint returns project budget changes that meet the following requirements:
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
Budget changes represent modifications or adjustments to project budgets.", "operationId":"/budgetChange/projectBudget/{projectBudgetId}_getBudgetChangesByProjectBudget", "parameters":[ { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-projectBudget-{projectBudgetId}-get", "x-filename-id":"budgetchange-projectbudget-projectbudgetid-get" } }, "/budgetChange/{budgetChangeId}/transactions":{ "get":{ "tags":[ "Project Budget Change" ], "summary":"View Budget Transactions by Project Budget Change", "description":"This endpoint returns budget transactions that meet the following requirements:
  • The object is associated with a project budget change with an ID value that matches the value of the {budgetChangeId} path parameter.
Budget transactions capture the budget transfers and budget changes for project budgets.", "operationId":"/budgetChange/{budgetChangeId}/transactions_getBudgetTransactionsByBudgetChange", "parameters":[ { "name":"budgetChangeId", "in":"path", "description":"The system-generated identifier of a budget change.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget change does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-{budgetChangeId}-transactions-get", "x-filename-id":"budgetchange-budgetchangeid-transactions-get" } }, "/budgetChange/syncBatch":{ "post":{ "tags":[ "Project Budget Change" ], "summary":"Batch Sync Project Budget Changes", "description":"Send a request to this endpoint to create or update one or more project budget changes.", "operationId":"/budgetChange/syncBatch_syncBatch_6", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any project budget change sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more budget change objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Project_Budget_Change_using_an_existing_Budget_Item":{ "summary":"Create or Update Project Budget Change using an existing Budget Item", "description":"Payload to create or update project budget change of an existing budget item using the budget change code, budget item ID, amount cost which needs to be changed, project budget ID, and project ID.", "value":[ { "budgetChangeCode":"Construction Materials Change", "budgetTransactions":[ { "budgetItemId":438202, "budgetTransactionCost":{ "amountCostProject":200000 } } ], "projectBudgetId":1766710, "projectId":1656810 } ], "valueSetFlag":true }, "Create_or_Update_Project_Budget_Change_using_a_New_Budget_Item":{ "summary":"Create or Update Project Budget Change using a New Budget Item", "description":"Payload to create or update project budget change for adding a new budget item using the budget change code, project code, workspace code, budget item name, desired code, unit rate project, budget CBS sheet code ID, nonlabor budget cost category ID, and units of measure ID.", "value":[ { "budgetChangeCode":"Construction Materials Change-2", "projectCode":"New Town - City Mall", "workspaceCode":"North America", "budgetTransactions":[ { "budgetTransactionCost":{ "unitRateProject":5 }, "quantity":10, "budgetItemName":"External Labor", "desiredCode":"External Labor", "budgetCbsSheetCodeId":126101, "budgetCostCategoryId":66002, "unitOfMeasureId":36001 } ] } ], "valueSetFlag":true }, "Create_or_Update_Project_Budget_Change_to_Assign_a_Configured_Field":{ "summary":"Create or Update Project Budget Change to Assign a Configured Field", "description":"Payload to create or update project budget change for adding a new budget item using the budget change code, project code, workspace code, budget item name, desired code, unit rate project, budget CBS sheet code ID, nonlabor budget cost category ID, units of measure ID, budget change ID and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "budgetChangeCode":"Construction Materials Change-2", "projectCode":"New Town - City Mall", "workspaceCode":"North America", "budgetTransactions":[ { "budgetTransactionCost":{ "unitRateProject":5 }, "quantity":10, "budgetItemName":"External Labor", "desiredCode":"External Labor", "budgetCbsSheetCodeId":126101, "budgetCostCategoryId":66002, "unitOfMeasureId":36001 } ], "configuredFields":[ { "columnLabel":"Notes", "textValue":"project Budget change Notes - Budg1" }, { "columnDefinationId":61045, "textValue":"N" } ] }, { "budgetChangeId":134106, "budgetTransactions":[ { "budgetTransactionId":484215, "budgetTransactionCost":{ "amountCostProject":350000 } } ], "configuredFields":[ { "columnLabel":"Notes", "textValue":"project Budget change Notes - Budg1" }, { "columnDefinationId":60045, "numberValue":2 } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetChange-syncBatch-post", "x-filename-id":"budgetchange-syncbatch-post" } }, "/budgetItem":{ "put":{ "tags":[ "Project Budget Item" ], "summary":"Update a Project Budget Item", "description":"Send a request to this endpoint to update a project budget item. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/budgetItem_update_7", "requestBody":{ "description":"A budget item object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetItemInput", "$ref":"#/components/schemas/ApiEntityBudgetItemInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Budget_Item_by_Removing_a_Configured_Fiel":{ "summary":"Update a Project Budget Item by Removing a Configured Field", "description":"Payload to update project budget item using budget item ID and specifying the action and column label for the configured field to be removed.", "value":{ "budgetItemId":440303, "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true }, "Update_a_Project_Budget_Item_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Project Budget Item to Assign a Boolean Configured Field", "description":"Payload to update the original cost amount of project budget item using budget item ID and configured field column label and text value", "value":{ "budgetItemId":440303, "budgetItemCost":{ "originalCostProject":55000 }, "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Project_Budget_Item_Using_Budget_Item_ID":{ "summary":"Update a Project Budget Item Using Budget Item ID", "description":"Payload to update the original cost amount of project budget item using budget item ID.", "value":{ "budgetItemId":440303, "budgetItemCost":{ "originalCostProject":55000 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Item service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetItem-put", "x-filename-id":"budgetitem-put" }, "post":{ "tags":[ "Project Budget Item" ], "summary":"Create a Project Budget Item", "description":"Send a request to this endpoint to create a project budget item. An application object will be created using the JSON data provided in the request body.", "operationId":"/budgetItem_create_8", "requestBody":{ "description":"A budget item object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetItemInput", "$ref":"#/components/schemas/ApiEntityBudgetItemInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Budget_Item":{ "summary":"Create a Project Budget Item", "description":"Payload to create a project budget item using the item name, budget item code, original cost, project ID, and CBS sheet code ID.", "value":{ "itemName":"Construction Materials", "budgetItemCode":"1", "budgetItemCost":{ "originalCostProject":500000 }, "projectId":1656811, "cbsSheetCodeId":1947504 }, "valueSetFlag":true }, "Create_a_Project_Budget_Item_that_includes_Configured_Field_Text":{ "summary":"Create a Project Budget Item that includes Configured Field Text", "description":"Payload to create a project budget item using the item name, budget item code, original cost, project ID, CBS sheet code ID, and values for the configured field which include column name and text value.", "value":{ "itemName":"Construction Materials", "budgetItemCode":"1", "budgetItemCost":{ "originalCostProject":500000 }, "projectId":1656811, "cbsSheetCodeId":1947504, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" } ] }, "valueSetFlag":true }, "Create_a_Project_Budget_Item_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Project Budget Item that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a project budget item using the item name, budget item code, original cost, project ID, CBS sheet code ID, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "itemName":"Construction Materials", "budgetItemCode":"1", "budgetItemCost":{ "originalCostProject":500000 }, "projectId":1656811, "cbsSheetCodeId":1947504, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Item service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetItem", "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-post", "x-filename-id":"budgetitem-post" } }, "/budgetItem/batch":{ "put":{ "tags":[ "Project Budget Item" ], "summary":"Batch Update Project Budget Items", "description":"Send a request to this endpoint to update one or more project budget items. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/budgetItem/batch_updateBatch_7", "requestBody":{ "description":"One or more budget item objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Budget_Items_to_Assign_Configured_Field":{ "summary":"Batch Update Project Budget Items to Assign Configured Field", "description":"Payload to update the original cost amount of one or more project budget items using the budget item IDs and and configured field column name, column label, column definition ID, and text value.", "value":[ { "budgetItemId":440303, "budgetItemCost":{ "originalCostProject":55000 }, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "budgetItemId":440304, "budgetItemCost":{ "originalCostProject":65000 }, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "textValue":"N" } ] } ], "valueSetFlag":true }, "Batch_Update_Project_Budget_Items_Using_Budget_Item_IDs":{ "summary":"Batch Update Project Budget Items Using Budget Item IDs", "description":"Payload to update the original cost amount of one or more project budget items using the budget item IDs.", "value":[ { "budgetItemId":440303, "budgetItemCost":{ "originalCostProject":55000 } }, { "budgetItemId":440304, "budgetItemCost":{ "originalCostProject":65000 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Item service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"budgetItem-batch-put", "x-filename-id":"budgetitem-batch-put" }, "post":{ "tags":[ "Project Budget Item" ], "summary":"Batch Create Project Budget Items", "description":"Send a request to this endpoint to create one or more project budget items. An application object will be created for each JSON object provided in the request body.", "operationId":"/budgetItem/batch_createBatch_8", "requestBody":{ "description":"One or more budget item objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Budget_Items_that_include_Configured_Field_Text":{ "summary":"Batch Create Project Budget Items that include Configured Field Text", "description":"Payload to create one or more project budget items using the item names, budget item codes, original costs, project IDs, CBS sheet code IDs, and and values for the configured field which include column name, column definition ID, text value.", "value":[ { "itemName":"Construction Materials", "budgetItemCode":"1", "budgetItemCost":{ "originalCostProject":50000 }, "projectId":1656811, "cbsSheetCodeId":1947504, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "itemName":"Internal Labor", "budgetItemCode":"2", "budgetItemCost":{ "originalCostProject":60000 }, "projectId":1656811, "cbsSheetCodeId":1947504, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true }, "Batch_Create_Project_Budget_Items":{ "summary":"Batch Create Project Budget Items", "description":"Payload to create one or more project budget items using the item names, budget item codes, original costs, project IDs, and CBS sheet code IDs.", "value":[ { "itemName":"Construction Materials", "budgetItemCode":"1", "budgetItemCost":{ "originalCostProject":50000 }, "projectId":1656811, "cbsSheetCodeId":1947504 }, { "itemName":"Internal Labor", "budgetItemCode":"2", "budgetItemCost":{ "originalCostProject":60000 }, "projectId":1656811, "cbsSheetCodeId":1947504 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Item service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-batch-post", "x-filename-id":"budgetitem-batch-post" }, "delete":{ "tags":[ "Project Budget Item" ], "summary":"Batch Delete Project Budget Items", "description":"Send a request to this endpoint to delete one or more project budget items. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/budgetItem/batch_deleteBatch_7", "requestBody":{ "description":"One or more system-generated identifiers of budget items.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Item service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetItem-batch-delete", "x-filename-id":"budgetitem-batch-delete" } }, "/budgetItem/{budgetItemId}":{ "delete":{ "tags":[ "Project Budget Item" ], "summary":"Delete a Project Budget Item", "description":"Send a request to this endpoint to delete a project budget item. The application object with an ID value that matches the value of the {budgetItemId} path parameter will be deleted.", "operationId":"/budgetItem/{budgetItemId}_delete_7", "parameters":[ { "name":"budgetItemId", "in":"path", "description":"The system-generated identifier of a budget item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Project Budget Item service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetItem-{budgetItemId}-delete", "x-filename-id":"budgetitem-budgetitemid-delete" } }, "/budgetItem/projectBudget/{projectBudgetId}/code/{budgetItemCode}":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View Project Budget Item by Code and Project Budget", "description":"This endpoint returns project budget items that meet the following requirements:
  • The object has a code that matches the value of the {budgetItemCode} path parameter.
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
Budget items represent costs associated with labor or other project expenses.", "operationId":"/budgetItem/projectBudget/{projectBudgetId}/code/{budgetItemCode}_findByCodeAndProjectBudgetId_1", "parameters":[ { "name":"budgetItemCode", "in":"path", "description":"The item code of a budget item.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget item does not exist, or you do not have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-projectBudget-{projectBudgetId}-code-{budgetItemCode}-get", "x-filename-id":"budgetitem-projectbudget-projectbudgetid-code-budgetitemcode-get" } }, "/budgetItem/project/{projectId}/code/{budgetItemCode}":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View Project Budget Item by Code and Project", "description":"This endpoint returns project budget items that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a code that matches the value of the {budgetItemCode} path parameter.
Budget items represent costs associated with labor or other project expenses.", "operationId":"/budgetItem/project/{projectId}/code/{budgetItemCode}_findByCodeAndProjectId_2", "parameters":[ { "name":"budgetItemCode", "in":"path", "description":"The item code of a budget item.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget item does not exist, or you do not have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-project-{projectId}-code-{budgetItemCode}-get", "x-filename-id":"budgetitem-project-projectid-code-budgetitemcode-get" } }, "/budgetItem/name/{itemName}":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View Project Budget Items by Name", "description":"This endpoint returns project budget items that meet the following requirements:
  • The object has a name that matches the value of the {itemName} path parameter.
Budget items represent costs associated with labor or other project expenses.", "operationId":"/budgetItem/name/{itemName}_findByName_1", "parameters":[ { "name":"itemName", "in":"path", "description":"The name of a budget item.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project budget item does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-name-{itemName}-get", "x-filename-id":"budgetitem-name-itemname-get" } }, "/budgetItem/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View a Project Budget Item by Project and Assigned Configured Field", "description":"This endpoint returns project budget items that meet the following requirements:
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Budget items represent costs associated with labor or other project expenses.", "operationId":"/budgetItem/project/{projectId}/configuredField/{viewColumnName}/{value}_findByProjectAndUDFValue_1", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project budget item does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"budgetitem-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/budgetItem/projectBudget/{projectBudgetId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View a Project Budget Item by Project Budget and Assigned Configured Field", "description":"This endpoint returns project budget items that meet the following requirements:
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
Budget items represent costs associated with labor or other project expenses.", "operationId":"/budgetItem/projectBudget/{projectBudgetId}/configuredField/{viewColumnName}/{value}_findByProjectBudgetAndUDFValue_1", "parameters":[ { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project budget item does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-projectBudget-{projectBudgetId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"budgetitem-projectbudget-projectbudgetid-configuredfield-viewcolumnname-value-get" } }, "/budgetItem/{budgetItemId}/transactions/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View Budget Transactions by Assigned Configured Field ", "description":"This endpoint returns budget transactions that meet the following requirements:
  • The object is associated with a project budget item with an ID value that matches the value of the {budgetItemId} path parameter.
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
Budget transactions capture the budget transfers and budget changes for project budgets. ", "operationId":"/budgetItem/{budgetItemId}/transactions/configuredField/{viewColumnName}/{value}_findByUDFValue_2", "parameters":[ { "name":"budgetItemId", "in":"path", "description":"The system-generated identifier of a budget item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested Budget Transaction does not exist, or you don't have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-{budgetItemId}-transactions-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"budgetitem-budgetitemid-transactions-configuredfield-viewcolumnname-value-get" } }, "/budgetItem/externallySourced":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View Integrated Budget Items", "description":"This endpoint returns all integrated budget item objects.", "operationId":"/budgetItem/externallySourced_findForSource", "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-externallySourced-get", "x-filename-id":"budgetitem-externallysourced-get" } }, "/budgetItem/byParent":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View all Project Budget Items by Parent", "description":"Send a request to this endpoint to view all project budget items under parent with codes matching the code fields in query parameters.", "operationId":"/budgetItem/byParent_getAllBudgetItemsByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the budget items have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code under which all the budget items have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-byParent-get", "x-filename-id":"budgetitem-byparent-get" } }, "/budgetItem/byItemCode":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View a Project Budget Item by Code and Parent Codes", "description":"Send a request to this endpoint to view a budget item with codes matching the code fields in query parameters.", "operationId":"/budgetItem/byItemCode_getBudgetItemByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the budget item to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the budget item to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"budgetItemCode", "in":"query", "description":"The item code of a budget item.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetItem", "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-byItemCode-get", "x-filename-id":"budgetitem-byitemcode-get" } }, "/budgetItem/project/{projectId}":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View Project Budget Items by Project", "description":"This endpoint returns project budget items that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Budget items represent costs associated with labor or other project expenses.", "operationId":"/budgetItem/project/{projectId}_getBudgetItemsByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget item does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-project-{projectId}-get", "x-filename-id":"budgetitem-project-projectid-get" } }, "/budgetItem/projectBudget/{projectBudgetId}":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View Project Budget Items by Project Budget", "description":"This endpoint returns project budget items that meet the following requirements:
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
Budget items represent costs associated with labor or other project expenses.", "operationId":"/budgetItem/projectBudget/{projectBudgetId}_getBudgetItemsByProjectBudget", "parameters":[ { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget item does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-projectBudget-{projectBudgetId}-get", "x-filename-id":"budgetitem-projectbudget-projectbudgetid-get" } }, "/budgetItem/{budgetItemId}/transactions":{ "get":{ "tags":[ "Project Budget Item" ], "summary":"View Budget Transactions by Project Budget Item", "description":"This endpoint returns budget transactions that meet the following requirements:
  • The object is associated with a project budget item with an ID value that matches the value of the {budgetItemId} path parameter.
Budget transactions capture the budget transfers and budget changes for project budgets.", "operationId":"/budgetItem/{budgetItemId}/transactions_getBudgetTransactionsByBudgetItem", "parameters":[ { "name":"budgetItemId", "in":"path", "description":"The system-generated identifier of a budget item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Budget Transaction does not exist, or you don't have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-{budgetItemId}-transactions-get", "x-filename-id":"budgetitem-budgetitemid-transactions-get" } }, "/budgetItem/sync":{ "post":{ "tags":[ "Project Budget Item" ], "summary":"Integrate a Budget Item with an External Data Source", "description":"Send a request to this endpoint to create or update an integrated a budget item. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/budgetItem/sync_sync", "requestBody":{ "description":"The unique identifier of budget item data in an external source.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedBudgetItemInput", "$ref":"#/components/schemas/ApiEntityExternallySourcedBudgetItemInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-sync-post", "x-filename-id":"budgetitem-sync-post" } }, "/budgetItem/syncBatch":{ "post":{ "tags":[ "Project Budget Item" ], "summary":"Batch Integrate Budget Items with an External Data Source", "description":"Send a request to this endpoint to create or update one or more integrated budget items. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API. ", "operationId":"/budgetItem/syncBatch_syncBatch_7", "requestBody":{ "description":"One or more unique identifiers of budget item data in an external source.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedBudgetItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Project_Budget_Items_using_budget_item_codes_for_Nonlabor_Cost_Category_IDs":{ "summary":"Create or Update Project Budget Items using budget item codes for Nonlabor Cost Category IDs", "description":"Payload to create or update one or more project budget items using the project ID, budget item code name, item name, nonlabor cost category ID, units of measure ID, quantity, unit rate project cost, and CBS codes.", "value":[ { "projectId":46102, "sourceId":"101", "budgetItemCode":"CM", "itemName":"Construction Materials", "costCategoryId":66002, "unitsOfMeasureId":36001, "quantity":5, "budgetItemCost":{ "unitRateProject":10 }, "cbsSheetCodeId":1947504 } ], "valueSetFlag":true }, "Create_or_Update_Project_Budget_Items_using_Codes":{ "summary":"Create or Update Project Budget Items using Codes", "description":"Payload to create or update one or more project budget items using the project code, workspace code, budget item code, item name, original cost of the budget line item, and CBS codes.", "value":[ { "projectCode":"New Town - City Mall", "workspaceCode":"North America", "budgetItemCode":"CM1", "sourceId":"102", "itemName":"Construction Materials-1", "budgetItemCost":{ "originalCostProject":500 }, "cbsCodes":[ "EI" ] } ], "valueSetFlag":true }, "Create_or_Update_Project_Budget_to_Assign_a_Configured_Field":{ "summary":"Create or Update Project Budget Items to Assign a Configured Field", "description":"Payload to create or update one or more project budget items using the project code, workspace code, budget item code, item name, original cost of the budget line item, CBS codes, budget Item ID, and and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "projectCode":"New Town - City Mall", "workspaceCode":"North America", "budgetItemCode":"CM1", "sourceId":"102", "itemName":"Construction Materials-1", "budgetItemCost":{ "originalCostProject":500 }, "cbsCodes":[ "EI" ], "configuredFields":[ { "columnLabel":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":61045, "textValue":"N" } ] }, { "budgetItemId":440304, "configuredFields":[ { "columnLabel":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "numberValue":2 } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-syncBatch-post", "x-filename-id":"budgetitem-syncbatch-post" } }, "/budgetItem/sync/batch":{ "post":{ "tags":[ "Project Budget Item" ], "summary":"Batch Sync Project Budget Items", "description":"Send a request to this endpoint to create or update one or more project budget items", "operationId":"/budgetItem/sync/batch_syncBatchWithoutAutoApprove", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any budget item sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more budget item objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Project_Budget_Items_using_budget_item_codes_for_Nonlabor_Cost_Category_IDs":{ "summary":"Create or Update Project Budget Items using budget item codes for Nonlabor Cost Category IDs", "description":"Payload to create or update the project budget item using the project ID, budget item code name, item name, nonlabor cost category ID, units of measure ID, quantity, unit rate project cost, and CBS codes.", "value":[ { "projectId":46102, "budgetItemCode":"CM", "itemName":"Construction Materials", "costCategoryId":66002, "unitsOfMeasureId":36001, "quantity":5, "budgetItemCost":{ "unitRateProject":10 }, "cbsSheetCodeId":1947504 } ], "valueSetFlag":true }, "Create_or_Update_Project_Budget_Items_using_Codes":{ "summary":"Create or Update Project Budget Items using Codes", "description":"Payload to create or update the project budget item using the project code, workspace code, budget item code, item name, original cost of the budget line item, and CBS codes.", "value":[ { "projectCode":"New Town - City Mall", "workspaceCode":"North America", "budgetItemCode":"CM1", "itemName":"Construction Materials-1", "budgetItemCost":{ "originalCostProject":500 }, "cbsCodes":[ "EI" ] } ], "valueSetFlag":true }, "Create_or_Update_Project_Budget_Items_using_Labor_Cost_Category_Codes":{ "summary":"Create or Update Project Budget Items using Labor Cost Category Codes", "description":"Payload to create or update the project budget item using the project ID, budget item code, item name, cost category name, currency abbreviation, units of measure ID, quantity, production rate, labor rate project cost, and CBS codes.", "value":[ { "projectId":46102, "budgetItemCode":"CM1", "itemName":"Construction Materials", "abbreviation":"USD", "costCategoryName":"US-Dollar", "unitsOfMeasureId":36001, "quantity":5, "productionRate":10, "budgetItemCost":{ "laborRateProject":10 }, "cbsCodes":[ "EI" ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetItem-sync-batch-post", "x-filename-id":"budgetitem-sync-batch-post" } }, "/budgetPlanningScenario/updateScenarioStatus":{ "post":{ "tags":[ "Budget Planning Scenario" ], "summary":"Update Budget Planning Scenario Status", "description":"Send a request to this endpoint to update status of Budget Planning Scenario. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/budgetPlanningScenario/updateScenarioStatus_changeScenarioState", "requestBody":{ "description":"A Budget Planning Scenario object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScenarioStatus", "$ref":"#/components/schemas/ApiEntityScenarioStatus", "exampleSetFlag":false }, "examples":{ "Update_Budget_Planning_Scenario_Status_Using_Scenario_ID":{ "summary":"Update Budget Planning Scenario Status Using Scenario ID", "description":"Payload update the status of a scenario using the scenario ID.", "value":{ "scenarioId":722201, "scenarioStatus":"UNDER_REVIEW" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScenarioStatus", "$ref":"#/components/schemas/ApiEntityScenarioStatus", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-updateScenarioStatus-post", "x-filename-id":"budgetplanningscenario-updatescenariostatus-post" } }, "/budgetPlanningScenario/batchUpdateScenarioStatus":{ "post":{ "tags":[ "Budget Planning Scenario" ], "summary":"Batch Update Budget Planning Scenario Status", "description":"Send a request to this endpoint to update status of Budget Planning Scenarios. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/budgetPlanningScenario/batchUpdateScenarioStatus_changeScenarioStatuses", "requestBody":{ "description":"One or more Budget Planning Scenario objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioStatus", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Budget_Planning_Scenario_Status_Using_Scenario_IDs":{ "summary":"Batch Update Budget Planning Scenario Status Using Scenario IDs", "description":"Payload update the statuses of one or more budget planning scenarios using the scenario IDs.", "value":[ { "scenarioId":722201, "scenarioStatus":"UNDER_REVIEW" }, { "scenarioId":722203, "scenarioStatus":"APPROVED" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioStatus", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-batchUpdateScenarioStatus-post", "x-filename-id":"budgetplanningscenario-batchupdatescenariostatus-post" } }, "/budgetPlanningScenario":{ "put":{ "tags":[ "Budget Planning Scenario" ], "summary":"Update a Budget Planning Scenario", "description":"Send a request to this endpoint to update a budget planning scenario. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/budgetPlanningScenario_update_8", "requestBody":{ "description":"A Budget Planning Scenario object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetPlanningScenarioInput", "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenarioInput", "exampleSetFlag":false }, "examples":{ "Update_a_Budget_Planning_Scenario_Using_Scenario_ID":{ "summary":"Update a Budget Planning Scenario Using Scenario ID", "description":"Payload to update the budget for a project such as total, cost plan over periods, start date, and finish date using the scenario ID.", "value":{ "targetBudgetPeriods":[ { "year":2023, "month":1, "phaseCostCOR":100 } ], "targetBudgetCOR":5000, "planProjects":[ { "planProjectPeriods":[ { "year":2023, "month":1, "phaseCostCOR":200 } ], "totalCOR":2000, "startDate":"2023-01-01T00:00:00", "finishDate":"2023-12-31T00:00:00", "projectId":844601, "linked":false } ], "scenarioId":722201 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetPlanningScenario-put", "x-filename-id":"budgetplanningscenario-put" }, "post":{ "tags":[ "Budget Planning Scenario" ], "summary":"Create a Budget Planning Scenario", "description":"Send a request to this endpoint to create Budget Planning Scenario. An application object will be created using the JSON data provided in the request body.", "operationId":"/budgetPlanningScenario_create_9", "requestBody":{ "description":"A Budget Planning Scenario object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetPlanningScenarioInput", "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenarioInput", "exampleSetFlag":false }, "examples":{ "Create_a_Budget_Planning_Scenario":{ "summary":"Create a Budget Planning Scenario", "description":"Payload to create a budget planning scenario using the portfolio ID, plan period, scenario name, and status.", "value":{ "scenarioStatus":"IN_PLANNING", "planPeriod":2023, "portfolioId":404205, "scenarioName":"2023 Planning" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetPlanningScenario", "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenario", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-post", "x-filename-id":"budgetplanningscenario-post" } }, "/budgetPlanningScenario/batch":{ "put":{ "tags":[ "Budget Planning Scenario" ], "summary":"Batch Update Budget Planning Scenarios", "description":"Send a request to this endpoint to update one or more budget planning scenarios. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/budgetPlanningScenario/batch_updateBatch_8", "requestBody":{ "description":"One or more Budget Planning Scenario objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenarioInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Budget_Planning_Scenario_Status_Using_Scenario_IDs":{ "summary":"Batch Update Budget Planning Scenario Status Using Scenario IDs", "description":"Payload to update the budgets of a project such as total, cost plan over periods, start dates, and finish dates of one or more scenarios using the scenario IDs", "value":[ { "scenarioId":722201, "targetBudgetPeriods":[ { "year":2023, "month":1, "phaseCostCOR":100 } ], "targetBudgetCOR":5000, "planProjects":[ { "projectId":844601, "planProjectPeriods":[ { "year":2023, "month":1, "phaseCostCOR":200 } ], "totalCOR":2000, "startDate":"2023-01-01T00:00:00", "finishDate":"2023-12-31T00:00:00", "linked":false } ] }, { "scenarioId":722203, "targetBudgetPeriods":[ { "year":2024, "month":1, "phaseCostCOR":100 } ], "targetBudgetCOR":4000, "planProjects":[ { "projectId":844602, "planProjectPeriods":[ { "year":2024, "month":1, "phaseCostCOR":200 } ], "totalCOR":1000, "startDate":"2024-01-01T00:00:00", "finishDate":"2024-12-31T00:00:00", "linked":false } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"budgetPlanningScenario-batch-put", "x-filename-id":"budgetplanningscenario-batch-put" }, "post":{ "tags":[ "Budget Planning Scenario" ], "summary":"Batch Create Budget Planning Scenarios", "description":"Send a request to this endpoint to create one or more Budget Planning Scenarios. An application object will be created for each JSON object provided in the request body.", "operationId":"/budgetPlanningScenario/batch_createBatch_9", "requestBody":{ "description":"One or more Budget Planning Scenario objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenarioInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Budget_Planning_Scenarios":{ "summary":"Batch Create Budget Planning Scenarios", "description":"Payload to create one or more budget planning scenarios using the portfolio IDs, plan periods, scenario names, and statuses.", "value":[ { "scenarioStatus":"IN_PLANNING", "planPeriod":2023, "portfolioId":404205, "scenarioName":"2023 Planning" }, { "scenarioStatus":"IN_PLANNING", "planPeriod":2024, "portfolioId":404205, "scenarioName":"Evaluation" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenario", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-batch-post", "x-filename-id":"budgetplanningscenario-batch-post" }, "delete":{ "tags":[ "Budget Planning Scenario" ], "summary":"Batch Delete Budget Planning Scenarios", "description":"Send a request to this endpoint to delete one or more Budget Planning Scenarios. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/budgetPlanningScenario/batch_deleteBatch_8", "requestBody":{ "description":"The system-generated identifier of an Budget Plan Scenario.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetPlanningScenario-batch-delete", "x-filename-id":"budgetplanningscenario-batch-delete" } }, "/budgetPlanningScenario/{scenarioId}":{ "get":{ "tags":[ "Budget Planning Scenario" ], "summary":"View a Budget Planning Scenario", "description":"This endpoint returns budget planning scenarios that meet the following requirements:
  • The object has an ID value that matches the value of the {scenarioId} path parameter.
", "operationId":"/budgetPlanningScenario/{scenarioId}_find_9", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of an Budget Plan Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetPlanningScenario", "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenario", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "404":{ "description":"The requested scenario does not exist, or you do not have access to it." } }, "x-internal-id":"budgetPlanningScenario-{scenarioId}-get", "x-filename-id":"budgetplanningscenario-scenarioid-get" }, "delete":{ "tags":[ "Budget Planning Scenario" ], "summary":"Delete a Budget Planning Scenario", "description":"Send a request to this endpoint to delete a Budget Planning Scenario. The application object with an ID value that matches the value of the {scenarioId} path parameter will be deleted.", "operationId":"/budgetPlanningScenario/{scenarioId}_delete_8", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of an Budget Plan Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetPlanningScenario-{scenarioId}-delete", "x-filename-id":"budgetplanningscenario-scenarioid-delete" } }, "/budgetPlanningScenario/fund/{scenarioId}":{ "get":{ "tags":[ "Budget Planning Scenario" ], "summary":"View a Budget Planning Scenario Fund Data", "description":"This endpoint returns budget planning scenario fund data that meet the following requirements:
  • The object has an ID value that matches the value of the {scenarioId} path parameter.
", "operationId":"/budgetPlanningScenario/fund/{scenarioId}_findAssignedScenarioFund", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of an Budget Plan Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundPlanningScenario", "$ref":"#/components/schemas/ApiEntityFundPlanningScenario", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "404":{ "description":"The requested scenario does not exist, or you do not have access to it." } }, "x-internal-id":"budgetPlanningScenario-fund-{scenarioId}-get", "x-filename-id":"budgetplanningscenario-fund-scenarioid-get" } }, "/budgetPlanningScenario/planProjects/scenario/{scenarioId}":{ "get":{ "tags":[ "Budget Planning Scenario" ], "summary":"View all Budget Plan Projects", "description":"Send a request to this endpoint to view all budget plan projects in the budget planning scenario.", "operationId":"/budgetPlanningScenario/planProjects/scenario/{scenarioId}_getBudgetPlanProjectsByScenarioId", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of an Budget Plan Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scenario does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-planProjects-scenario-{scenarioId}-get", "x-filename-id":"budgetplanningscenario-planprojects-scenario-scenarioid-get" } }, "/budgetPlanningScenario/fund/planProjects/scenario/{scenarioId}":{ "get":{ "tags":[ "Budget Planning Scenario" ], "summary":"View all Fund Plan Projects", "description":"Send a request to this endpoint to view all plan projects with fund data in the budget planning scenario.", "operationId":"/budgetPlanningScenario/fund/planProjects/scenario/{scenarioId}_getFundPlanProjectsByScenarioId", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of an Budget Plan Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scenario does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPlanProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-fund-planProjects-scenario-{scenarioId}-get", "x-filename-id":"budgetplanningscenario-fund-planprojects-scenario-scenarioid-get" } }, "/budgetPlanningScenario/byPortfolioId":{ "get":{ "tags":[ "Budget Planning Scenario" ], "summary":"View All Budget Planning Scenarios by Portfolio and Plan Period", "description":"Send a request to this endpoint to view all Budget Planning Scenarios under parent with codes matching the code fields in query parameters.", "operationId":"/budgetPlanningScenario/byPortfolioId_getScenariosByPortfolioIdAndPlanPeriod", "parameters":[ { "name":"portfolioId", "in":"query", "description":"The system-generated identifier of a portfolio.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"planPeriod", "in":"query", "description":"The period during which budget is allocated to projects within the plan.
This value determines the year in which budget planning timescales start.
You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
After the planning period for a budget plan has been set it cannot be changed.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scenario does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenario", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-byPortfolioId-get", "x-filename-id":"budgetplanningscenario-byportfolioid-get" } }, "/budgetPlanningScenario/byPortfolioName":{ "get":{ "tags":[ "Budget Planning Scenario" ], "summary":"View All Budget Planning Scenarios by Portfolio Name and Plan Period", "description":"Send a request to this endpoint to view all Budget Planning Scenarios under parent with codes matching the code fields in query parameters.", "operationId":"/budgetPlanningScenario/byPortfolioName_getScenariosByPortfolioIdAndPlanPeriod_1", "parameters":[ { "name":"portfolioName", "in":"query", "description":"The name of a capital portfolio member.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"planPeriod", "in":"query", "description":"The period during which budget is allocated to projects within the plan.
This value determines the year in which budget planning timescales start.
You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
After the planning period for a budget plan has been set it cannot be changed.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scenario does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenario", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-byPortfolioName-get", "x-filename-id":"budgetplanningscenario-byportfolioname-get" } }, "/budgetPlanningScenario/fund/byPortfolioId":{ "get":{ "tags":[ "Budget Planning Scenario" ], "summary":"View All Budget Planning Scenarios Fund Data by Portfolio and Plan Period", "description":"Send a request to this endpoint to view all Budget Planning Scenarios with Fund data under parent with codes matching the code fields in query parameters.", "operationId":"/budgetPlanningScenario/fund/byPortfolioId_getScenariosWithFundDataByPortfolioIdAndPlanPeriod", "parameters":[ { "name":"portfolioId", "in":"query", "description":"The system-generated identifier of a portfolio.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"planPeriod", "in":"query", "description":"The period during which budget is allocated to projects within the plan.
This value determines the year in which budget planning timescales start.
You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
After the planning period for a budget plan has been set it cannot be changed.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scenario does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPlanningScenario", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-fund-byPortfolioId-get", "x-filename-id":"budgetplanningscenario-fund-byportfolioid-get" } }, "/budgetPlanningScenario/fund/byPortfolioName":{ "get":{ "tags":[ "Budget Planning Scenario" ], "summary":"View All Budget Planning Scenarios Fund Data by Portfolio Name and Plan Period", "description":"Send a request to this endpoint to view all Budget Planning Scenarios with Fund data under parent with codes matching the code fields in query parameters.", "operationId":"/budgetPlanningScenario/fund/byPortfolioName_getScenariosWithFundDataByPortfolioIdAndPlanPeriod_1", "parameters":[ { "name":"portfolioName", "in":"query", "description":"The name of a capital portfolio member.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"planPeriod", "in":"query", "description":"The period during which budget is allocated to projects within the plan.
This value determines the year in which budget planning timescales start.
You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
After the planning period for a budget plan has been set it cannot be changed.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scenario does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPlanningScenario", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-fund-byPortfolioName-get", "x-filename-id":"budgetplanningscenario-fund-byportfolioname-get" } }, "/budgetPlanningScenario/manageFundAllocation":{ "put":{ "tags":[ "Budget Planning Scenario" ], "summary":"Manage Fund Allocation of Budget Planning Scenario", "description":"Send a request to this endpoint to assign, unassign and update funds of budget planning scenario. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/budgetPlanningScenario/manageFundAllocation_manageFundAllocation", "requestBody":{ "description":"A Budget Planning Scenario object with Funds.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundPlanningScenarioInput", "$ref":"#/components/schemas/ApiEntityFundPlanningScenarioInput", "exampleSetFlag":false }, "examples":{ "Manage_Fund_Allocation_of_Budget_Planning_Scenario_Using_Scenario_ID":{ "summary":"Manage Fund Allocation of Budget Planning Scenario Using Scenario ID", "description":"Payload to allocate the portfolio funds to a project in a budget planning scenario using the scenario ID.", "value":{ "scenarioId":722201, "planProjects":[ { "projectId":844601, "portfolioProjectFunds":[ { "proposedFundCOR":2000, "periods":[ { "proposedFundCostCOR":200, "year":2023 } ], "fundId":40013 } ] } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetPlanningScenario-manageFundAllocation-put", "x-filename-id":"budgetplanningscenario-managefundallocation-put" } }, "/budgetPlanningScenario/manageFundAllocation/batch":{ "put":{ "tags":[ "Budget Planning Scenario" ], "summary":"Manage Fund Allocation of Budget Planning Scenarios", "description":"Send a request to this endpoint to assign, unassign and update funds of one or more budget planning scenarios. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/budgetPlanningScenario/manageFundAllocation/batch_manageFundAllocationBatch", "requestBody":{ "description":"One or more Budget Planning Scenario objects with Funds.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPlanningScenarioInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Manage_Fund_Allocation_of_Budget_Planning_Scenarios_Using_Scenario_IDs":{ "summary":"Batch Manage Fund Allocation of Budget Planning Scenarios Using Scenario IDs", "description":"Payload to allocate the portfolio funds to projects for one or more budget planning scenarios using the scenario IDs.", "value":[ { "scenarioId":722201, "planProjects":[ { "projectId":844601, "portfolioProjectFunds":[ { "proposedFundCOR":2000, "periods":[ { "proposedFundCostCOR":200, "year":2023 } ], "fundId":40013 } ] } ] }, { "scenarioId":722203, "planProjects":[ { "projectId":844602, "portfolioProjectFunds":[ { "proposedFundCOR":2000, "periods":[ { "proposedFundCostCOR":200, "year":2024 } ], "fundId":40013 } ] } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Budget Planning Scenario service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"budgetPlanningScenario-manageFundAllocation-batch-put", "x-filename-id":"budgetplanningscenario-managefundallocation-batch-put" } }, "/budgetPlanningScenario/refresh/{scenarioId}":{ "put":{ "tags":[ "Budget Planning Scenario" ], "summary":"Refresh a Budget Planning Scenario", "description":"Send a request to this endpoint to refresh a budget planning scenario. Refresh budget planning scenarios to ensure their plan projects contain up to all the linked projects.", "operationId":"/budgetPlanningScenario/refresh/{scenarioId}_refresh", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of an Budget Plan Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetPlanningScenario-refresh-{scenarioId}-put", "x-filename-id":"budgetplanningscenario-refresh-scenarioid-put" } }, "/budgetPlanningScenario/syncBatch":{ "post":{ "tags":[ "Budget Planning Scenario" ], "summary":"Batch Sync Budget Planning Scenarios", "description":"Send a request to this endpoint to create or update one or more budget planning scenarios.", "operationId":"/budgetPlanningScenario/syncBatch_syncBatch_8", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any budget planning scenarios sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more Budget Planning Scenario objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenarioInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Budget_Planning_Scenario":{ "summary":"Create or Update a Budget Planning Scenario", "description":"Payload to create or update a budget planning scenario using the portfolio ID, plan period, scenario name, and status.", "value":[ { "scenarioStatus":"IN_PLANNING", "planPeriod":2023, "portfolioId":404205, "scenarioName":"2023 Planning" } ], "valueSetFlag":true }, "Create_or_Update_a_Budget_Planning_Scenario_Using_Codes":{ "summary":"Create or Update a Budget Planning Scenario Using Codes", "description":"Payload to create or update a budget planning scenario using the portfolio name, workspace code, plan period, scenario name, and status.", "value":[ { "scenarioStatus":"IN_PLANNING", "planPeriod":2023, "portfolioName":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "scenarioName":"2023 Planning" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetPlanningScenario-syncBatch-post", "x-filename-id":"budgetplanningscenario-syncbatch-post" } }, "/budgetTransfer/{id}/changeBudgetTransferStatus":{ "put":{ "tags":[ "Project Budget Transfer" ], "summary":"Change a Project Budget Transfer Status", "description":"Send a request to this endpoint to modify the status of a project budget transfer.", "operationId":"/budgetTransfer/{id}/changeBudgetTransferStatus_changeBudgetTransferStatus", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a budget transfer.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"A new status for the project budget transfer.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStatusTransition", "$ref":"#/components/schemas/ApiEntityStatusTransition", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "responses":{ "404":{ "description":"The requested project budget transfer does not exist, or you do not have access to it. " }, "400":{ "description":"Invalid input for the Project Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetTransfer-{id}-changeBudgetTransferStatus-put", "x-filename-id":"budgettransfer-id-changebudgettransferstatus-put" } }, "/budgetTransfer":{ "put":{ "tags":[ "Project Budget Transfer" ], "summary":"Update a Project Budget Transfer", "description":"Send a request to this endpoint to update a project budget transfer. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/budgetTransfer_update_9", "requestBody":{ "description":"A budget transfer object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetTransferInput", "$ref":"#/components/schemas/ApiEntityBudgetTransferInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Budget_Transfer_Using_the_Budget_Transfer_ID":{ "summary":"Update a Project Budget Transfer Using the Budget Transfer ID", "description":"Payload to update the amount cost project of a project budget transfer using the budget transfer ID and budget transaction ID.", "value":{ "budgetTransferId":98112, "budgetTransactions":[ { "budgetTransactionId":484229, "budgetTransactionCost":{ "amountCostProject":55000 } }, { "budgetTransactionId":484230, "budgetTransactionCost":{ "amountCostProject":55000 } } ] }, "valueSetFlag":true }, "Update_a_Project_Budget_Transfer_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Project Budget Transfer to Assign a Boolean Configured Field", "description":"Payload to update the amount cost project of a project budget transfer using the budget transfer ID, budget transaction ID, and configured field column label and text value.", "value":{ "budgetTransferId":98112, "budgetTransactions":[ { "budgetTransactionId":484229, "budgetTransactionCost":{ "amountCostProject":55000 } }, { "budgetTransactionId":484230, "budgetTransactionCost":{ "amountCostProject":55000 } } ], "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Project_Budget_Transfer_by_Removing_a_Configured_Field":{ "summary":"Update a Project Budget Transfer by Removing a Configured Field", "description":"Payload to update the amount cost project of a project budget transfer using the budget transfer ID, budget transaction ID, and specifying the action and column label for the configured field to be removed.", "value":{ "budgetTransferId":98112, "budgetTransactions":[ { "budgetTransactionId":484229, "budgetTransactionCost":{ "amountCostProject":55000 } }, { "budgetTransactionId":484230, "budgetTransactionCost":{ "amountCostProject":55000 } } ], "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetTransfer-put", "x-filename-id":"budgettransfer-put" }, "post":{ "tags":[ "Project Budget Transfer" ], "summary":"Create a Project Budget Transfer", "description":"Send a request to this endpoint to create a project budget transfer. An application object will be created using the JSON data provided in the request body.", "operationId":"/budgetTransfer_create_10", "requestBody":{ "description":"A budget transfer object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetTransferInput", "$ref":"#/components/schemas/ApiEntityBudgetTransferInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Budget_Transfer_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Project Budget Transfer that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a project budget transfer using the budget transfer code, transfer from ID, transfer to ID, amount cost project, project ID, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "budgetTransferCode":"Materials to Labor", "budgetTransactions":[ { "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 } }, { "transferToId":440203, "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project transfer notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ], "projectId":1656814 }, "valueSetFlag":true }, "Create_a_Project_Budget_Transfer_that_includes_Configured_Field_Text":{ "summary":"Create a Project Budget Transfer that includes Configured Field Text", "description":"Payload to create a project budget transfer using the budget transfer code, transfer from ID, transfer to ID, amount cost project, project ID, and values for the configured field which include column name and text value for budget transactions and budget transfer.", "value":{ "budgetTransferCode":"Materials to Labor", "budgetTransactions":[ { "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 }, "configuredFields":[ { "columnName":"Notes-trans", "textValue":"project Budget transaction Notes" } ] }, { "transferToId":440203, "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 }, "configuredFields":[ { "columnName":"Notes-trans", "textValue":"project Budget transaction Notes" } ] } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project transfer notes" } ], "projectId":1656814 }, "valueSetFlag":true }, "Create_a_Project_Budget_Transfer":{ "summary":"Create a Project Budget Transfer", "description":"Payload to create a project budget transfer using the budget transfer code, transfer from ID, transfer to ID, amount cost project, and project ID.", "value":{ "budgetTransferCode":"Materials to Labor", "budgetTransactions":[ { "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 } }, { "transferToId":440203, "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 } } ], "projectId":1656814 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetTransfer", "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-post", "x-filename-id":"budgettransfer-post" } }, "/budgetTransfer/batch":{ "put":{ "tags":[ "Project Budget Transfer" ], "summary":"Batch Update Project Budget Transfers", "description":"Send a request to this endpoint to update one or more project budget transfers. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/budgetTransfer/batch_updateBatch_9", "requestBody":{ "description":"One or more budget transfer objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Budget_Transfers_to_Assign_Configured_Field":{ "summary":"Batch Update Project Budget Transfers to Assign Configured Field", "description":"Payload to update the amount cost project of one or more project budget transfers using budget transfer IDs, budget transaction IDs, and configured field column name, column label, column definition ID, and text value.", "value":[ { "budgetTransferId":98112, "budgetTransactions":[ { "budgetTransactionId":484229, "budgetTransactionCost":{ "amountCostProject":55000 } }, { "budgetTransactionId":484230, "budgetTransactionCost":{ "amountCostProject":55000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget transfer Notes - Budg1" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "budgetTransferId":98113, "budgetTransactions":[ { "budgetTransactionId":484231, "budgetTransactionCost":{ "amountCostProject":15000 } }, { "budgetTransactionId":484232, "budgetTransactionCost":{ "amountCostProject":15000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget transfer Notes - Budg2" }, { "columnDefinationId":60045, "textValue":"N" } ] } ], "valueSetFlag":true }, "Batch_Update_Project_Budget_Transfers_Using_the_Budget_Transfer_IDs":{ "summary":"Batch Update Project Budget Transfers Using the Budget Transfer IDs", "description":"Payload to update the amount cost project of one or more project budget transfers using budget transfer IDs and budget transaction IDs.", "value":[ { "budgetTransferId":98112, "budgetTransactions":[ { "budgetTransactionId":484229, "budgetTransactionCost":{ "amountCostProject":55000 } }, { "budgetTransactionId":484230, "budgetTransactionCost":{ "amountCostProject":55000 } } ] }, { "budgetTransferId":98113, "budgetTransactions":[ { "budgetTransactionId":484231, "budgetTransactionCost":{ "amountCostProject":15000 } }, { "budgetTransactionId":484232, "budgetTransactionCost":{ "amountCostProject":15000 } } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"budgetTransfer-batch-put", "x-filename-id":"budgettransfer-batch-put" }, "post":{ "tags":[ "Project Budget Transfer" ], "summary":"Batch Create Project Budget Transfers", "description":"Send a request to this endpoint to create one or more project budget transfers. An application object will be created for each JSON object provided in the request body.", "operationId":"/budgetTransfer/batch_createBatch_10", "requestBody":{ "description":"One or more budget transfer objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Budget_Transfers":{ "summary":"Batch Create Project Budget Transfers", "description":"Payload to create one or more project budget transfers using the budget transfer codes, transfer from IDs, transfer to IDs, amount cost projects, and project IDs.", "value":[ { "budgetTransferCode":"Materials to Labor", "budgetTransactions":[ { "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 } }, { "transferToId":440203, "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 } } ], "projectId":1656814 }, { "budgetTransferCode":"Materials to Design", "budgetTransactions":[ { "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":100000 } }, { "transferToId":440203, "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":100000 } } ], "projectId":1656814 } ], "valueSetFlag":true }, "Batch_Create_Project_Budget_Transfers_that_include_Configured_Field_Text":{ "summary":"Batch Create Project Budget Transfers that include Configured Field Text", "description":"Payload to create one or more project budget transfers using the budget transfer codes, transfer from IDs, transfer to IDs, amount cost projects, project IDs and values for the configured field which include column name, column definition ID, text value.", "value":[ { "budgetTransferCode":"Materials to Labor", "budgetTransactions":[ { "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 } }, { "transferToId":440203, "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":50000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget transfer Notes - Budg1" }, { "columnDefinationId":60045, "textValue":"N" } ], "projectId":1656814 }, { "budgetTransferCode":"Materials to Design", "budgetTransactions":[ { "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":100000 } }, { "transferToId":440203, "transferFromId":440202, "budgetTransactionCost":{ "amountCostProject":100000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget change Notes - Budg2" }, { "columnDefinationId":60045, "textValue":"Y" } ], "projectId":1656814 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-batch-post", "x-filename-id":"budgettransfer-batch-post" }, "delete":{ "tags":[ "Project Budget Transfer" ], "summary":"Batch Delete Project Budget Transfers", "description":"Send a request to this endpoint to delete one or more project budget transfers. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/budgetTransfer/batch_deleteBatch_9", "requestBody":{ "description":"One or more system-generated identifiers of budget transfers.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetTransfer-batch-delete", "x-filename-id":"budgettransfer-batch-delete" } }, "/budgetTransfer/{budgetTransferId}":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View a Project Budget Transfer", "description":"This endpoint returns project budget transfers that meet the following requirements:
  • The object is associated with a project budget transfer with an ID value that matches the value of the {budgetTransferId} path parameter.
Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/budgetTransfer/{budgetTransferId}_find_10", "parameters":[ { "name":"budgetTransferId", "in":"path", "description":"The system-generated identifier of a budget transfer.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget transfer does not exist, or you do not have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetTransfer", "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-{budgetTransferId}-get", "x-filename-id":"budgettransfer-budgettransferid-get" }, "delete":{ "tags":[ "Project Budget Transfer" ], "summary":"Delete a Project Budget Transfer", "description":"Send a request to this endpoint to delete a project budget transfer. The application object with an ID value that matches the value of the {budgetTransferId} path parameter will be deleted.", "operationId":"/budgetTransfer/{budgetTransferId}_delete_9", "parameters":[ { "name":"budgetTransferId", "in":"path", "description":"The system-generated identifier of a budget transfer.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Project Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"budgetTransfer-{budgetTransferId}-delete", "x-filename-id":"budgettransfer-budgettransferid-delete" } }, "/budgetTransfer/projectBudget/{projectBudgetId}/code/{budgetTransferCode}":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View Project Budget Transfer by Code and Project Budget", "description":"This endpoint returns project budget transfers that meet the following requirements:
  • The object has a code that matches the value of the {budgetTransferCode} path parameter.
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/budgetTransfer/projectBudget/{projectBudgetId}/code/{budgetTransferCode}_findByCodeAndProjectBudgetId_2", "parameters":[ { "name":"budgetTransferCode", "in":"path", "description":"The user-specified identifier of a budget transfer.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget transfer does not exist, or you do not have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-projectBudget-{projectBudgetId}-code-{budgetTransferCode}-get", "x-filename-id":"budgettransfer-projectbudget-projectbudgetid-code-budgettransfercode-get" } }, "/budgetTransfer/project/{projectId}/code/{budgetTransferCode}":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View a Project Budget Transfer by Code and Project", "description":"This endpoint returns project budget transfers that meet the following requirements:
  • The object has a code that matches the value of the {budgetTransferCode} path parameter.
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/budgetTransfer/project/{projectId}/code/{budgetTransferCode}_findByCodeAndProjectId_3", "parameters":[ { "name":"budgetTransferCode", "in":"path", "description":"The user-specified identifier of a budget transfer.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget transfer does not exist, or you do not have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-project-{projectId}-code-{budgetTransferCode}-get", "x-filename-id":"budgettransfer-project-projectid-code-budgettransfercode-get" } }, "/budgetTransfer/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View Project Budget Transfer by Assigned Configured Field", "description":"This endpoint returns project budget transfers that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/budgetTransfer/project/{projectId}/configuredField/{viewColumnName}/{value}_findByProjectAndUDFValue_2", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project budget transfer does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"budgettransfer-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/budgetTransfer/projectBudget/{projectBudgetId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View Project Budget Transfer by Assigned Configured Field", "description":"This endpoint returns project budget transfers that meet the following requirements:
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/budgetTransfer/projectBudget/{projectBudgetId}/configuredField/{viewColumnName}/{value}_findByProjectBudgetAndUDFValue_2", "parameters":[ { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project budget transfer does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-projectBudget-{projectBudgetId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"budgettransfer-projectbudget-projectbudgetid-configuredfield-viewcolumnname-value-get" } }, "/budgetTransfer/{budgetTransferId}/statusTransitionHistory":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View Status Transition History Records by Project Budget Transfer", "description":"This endpoint returns status transition histories of project budget transfers that meet the following requirements:
  • The object is associated with a project budget transfer with an ID value that matches the value of the {budgetTransferId} path parameter.
Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/budgetTransfer/{budgetTransferId}/statusTransitionHistory_findTransitionHistoryByBudgetTransferId", "parameters":[ { "name":"budgetTransferId", "in":"path", "description":"The system-generated identifier of a budget transfer.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested status transition history record does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-{budgetTransferId}-statusTransitionHistory-get", "x-filename-id":"budgettransfer-budgettransferid-statustransitionhistory-get" } }, "/budgetTransfer/project/{projectId}/statusTransitionHistory":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View Status Transition History Records by Project", "description":"This endpoint returns project budget transfer status transition histories that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/budgetTransfer/project/{projectId}/statusTransitionHistory_findTransitionHistoryByProjectId_1", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested status transition history record does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-project-{projectId}-statusTransitionHistory-get", "x-filename-id":"budgettransfer-project-projectid-statustransitionhistory-get" } }, "/budgetTransfer/byParent":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View all Project Budget Transfers by Parent", "description":"Send a request to this endpoint to view all project budget transfers under parent with codes matching the code fields in query parameters.", "operationId":"/budgetTransfer/byParent_getAllBudgetTransferByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the budget transfers have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code under which all the budget transfers have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-byParent-get", "x-filename-id":"budgettransfer-byparent-get" } }, "/budgetTransfer/{budgetTransferId}/transactions":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View Budget Transactions by Project Budget Transfer", "description":"This endpoint returns budget transactions that meet the following requirements:
  • The object is associated with a project budget transfer with an ID value that matches the value of the {budgetTransferId} path parameter.
Budget transactions capture the budget transfers and budget changes for project budgets.", "operationId":"/budgetTransfer/{budgetTransferId}/transactions_getBudgetTransactionsByBudgetTransfer", "parameters":[ { "name":"budgetTransferId", "in":"path", "description":"The system-generated identifier of a budget transfer.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Budget Transaction does not exist, or you don't have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-{budgetTransferId}-transactions-get", "x-filename-id":"budgettransfer-budgettransferid-transactions-get" } }, "/budgetTransfer/byItemCode":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View a Project Budget Transfer by Code and Parent Codes", "description":"Send a request to this endpoint to view a project budget transfer with codes matching the code fields in query parameters.", "operationId":"/budgetTransfer/byItemCode_getBudgetTransferByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the budget transfer to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the budget transfer to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"budgetTransferCode", "in":"query", "description":"The user-specified identifier of a budget transfer.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBudgetTransfer", "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-byItemCode-get", "x-filename-id":"budgettransfer-byitemcode-get" } }, "/budgetTransfer/project/{projectId}":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View Project Budget Transfers by Project", "description":"This endpoint returns project budget transfers that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/budgetTransfer/project/{projectId}_getBudgetTransfersByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget transfer does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-project-{projectId}-get", "x-filename-id":"budgettransfer-project-projectid-get" } }, "/budgetTransfer/projectBudget/{projectBudgetId}":{ "get":{ "tags":[ "Project Budget Transfer" ], "summary":"View Project Budget Transfers by Project Budget", "description":"This endpoint returns project budget transfers that meet the following requirements:
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
Budget transfers represent adjustments to budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/budgetTransfer/projectBudget/{projectBudgetId}_getBudgetTransfersByProjectBudget", "parameters":[ { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget transfer does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-projectBudget-{projectBudgetId}-get", "x-filename-id":"budgettransfer-projectbudget-projectbudgetid-get" } }, "/budgetTransfer/syncBatch":{ "post":{ "tags":[ "Project Budget Transfer" ], "summary":"Batch Sync Project Budget Transfers", "description":"Send a request to this endpoint to create or update one or more project budget transfers.", "operationId":"/budgetTransfer/syncBatch_syncBatch_9", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any project budget transfer sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more budget transfer objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Project_Budget_Transfer_from_One_Source_to_One_Destination":{ "summary":"Create or Update Project Budget Transfer from One Source to One Destination", "description":"Payload to create or update the project budget transfer using the project code, workspace code, budget transfer code, and budget transactions, such as transfer-from ID, budget item ID, amount cost that's needed to transfer, transaction type, and budget transfer type.", "value":[ { "budgetTransferCode":"Materials to Labor", "projectId":46102, "status":"DRAFT", "budgetTransactions":[ { "transferFromId":18003, "budgetItemId":18003, "budgetTransactionCost":{ "amountCostProject":10 }, "transactionType":"TRANSFER", "budgetTransferType":"FROM" }, { "transferFromId":18003, "transferToId":18002, "budgetItemId":18002, "budgetTransactionCost":{ "amountCostProject":10 }, "transactionType":"TRANSFER", "budgetTransferType":"TO" } ] } ], "valueSetFlag":true }, "Create_or_Update_Project_Budget_Transfer_from_One_Source_to_Multiple_Destinations":{ "summary":"Create or Update Project Budget Transfer from One Source to Multiple Destinations", "description":"Payload to create or update the project budget transfer using the project code, workspace code, budget transfer code, and budget transactions, such as transfer-from ID, budget item ID, amount cost that's needed to transfer, transaction type, and budget transfer type.", "value":[ { "budgetTransferCode":"Materials to Labor", "projectCode":"New Town - City Mall", "workspaceCode":"North America", "budgetTransactions":[ { "transferFromId":18002, "budgetItemId":18002, "budgetTransactionCost":{ "amountCostProject":20 }, "transactionType":"TRANSFER", "budgetTransferType":"FROM" }, { "transferFromId":18002, "transferToId":18003, "budgetItemId":18003, "budgetTransactionCost":{ "amountCostProject":10 }, "transactionType":"TRANSFER", "budgetTransferType":"TO" }, { "transferFromId":18002, "transferToId":18004, "budgetItemId":18004, "budgetTransactionCost":{ "amountCostProject":10 }, "transactionType":"TRANSFER", "budgetTransferType":"TO" } ] } ], "valueSetFlag":true }, "Create_or_Update_Project_Budget_Transfer_to_Assign_a_Configured_Field":{ "summary":"Create or Update Project Budget Transfer to Assign a Configured Field", "description":"Payload to create or update the project budget transfer using the project code, workspace code, budget transfer code, and budget transactions, such as transfer-from ID, budget item ID, amount cost that's needed to transfer, transaction type, budget transfer type, budget transfer ID and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "budgetTransferCode":"Materials to Labor", "projectId":46102, "status":"DRAFT", "budgetTransactions":[ { "transferFromId":18003, "budgetItemId":18003, "budgetTransactionCost":{ "amountCostProject":10 }, "transactionType":"TRANSFER", "budgetTransferType":"FROM" }, { "transferFromId":18003, "transferToId":18002, "budgetItemId":18002, "budgetTransactionCost":{ "amountCostProject":10 }, "transactionType":"TRANSFER", "budgetTransferType":"TO" } ], "configuredFields":[ { "columnLabel":"Notes", "textValue":"project Budget change transfer - Budg1" }, { "columnDefinationId":61045, "textValue":"N" } ] }, { "budgetTransferId":98113, "configuredFields":[ { "columnLabel":"Notes", "textValue":"project Budget change transfer - Budg1" }, { "columnDefinationId":61045, "numberValue":2 } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"budgetTransfer-syncBatch-post", "x-filename-id":"budgettransfer-syncbatch-post" } }, "/cbs/import/workspace/{workspaceCode}/project/{projectCode}":{ "put":{ "tags":[ "CBS" ], "summary":"Push Down all Workspace CBS Code to Project", "description":"Send a request to this endpoint to push down workspace CBS codes to a project.
Update Key : 'cbsTemplateCodeId'", "operationId":"/cbs/import/workspace/{workspaceCode}/project/{projectCode}_copyAllWorkspaceCbsCodeToProject", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"Workspace Code whose CBS codes have to be pushed down.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"path", "description":"Project Code where CBS codes have to be pushed down.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-import-workspace-{workspaceCode}-project-{projectCode}-put", "x-filename-id":"cbs-import-workspace-workspacecode-project-projectcode-put" } }, "/cbs/createprojectCBS":{ "post":{ "tags":[ "CBS" ], "summary":"Create a Project CBS", "description":"Send a request to this endpoint to create a project CBS. An application object will be created using the JSON data provided in the request body. \nNote: Before you can create a project CBS, you must create a project CBS segment.", "operationId":"/cbs/createprojectCBS_createProjectCBS", "requestBody":{ "description":"A CBS object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSSheetCodeInput", "$ref":"#/components/schemas/ApiEntityCBSSheetCodeInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_CBS_that_includes_Configured_Field_Text":{ "summary":"Create a Project CBS that includes Configured Field Text", "description":"Payload to create project cbs using the project ID, cbs code, description, cost type, and values for the configured field which include column name and text value.", "value":{ "description":"Exterior Improvement", "projectId":30101, "cbsCode":"CONR", "costType":"CAPITAL", "costSheetRow":{ "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of project cbs" } ] } }, "valueSetFlag":true }, "Create_a_Project_CBS":{ "summary":"Create a Project CBS", "description":"Payload to create project cbs using the project ID, cbs code, description, and cost type.", "value":{ "description":"Exterior Improvement", "projectId":30101, "cbsCode":"CONR", "costType":"CAPITAL" }, "valueSetFlag":true }, "Create_a_Project_CBS_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Project CBS that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create project cbs using the project ID, cbs code, description, cost type, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "description":"Exterior Improvement", "projectId":30101, "cbsCode":"CONR", "costType":"CAPITAL", "costSheetRow":{ "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of project cbs" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSSheetCode", "$ref":"#/components/schemas/ApiEntityCBSSheetCode", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-createprojectCBS-post", "x-filename-id":"cbs-createprojectcbs-post" } }, "/cbs/project/{projectId}/projectCostingSource":{ "get":{ "tags":[ "CBS" ], "summary":"View a Project Costing Source ", "description":"This endpoint returns project costing sources that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
A CBS is used to track, manage, and report costs related to a project.", "operationId":"/cbs/project/{projectId}/projectCostingSource_getProjectCostingSource", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project costing source.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectCostingSource", "$ref":"#/components/schemas/ApiEntityProjectCostingSource", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-project-{projectId}-projectCostingSource-get", "x-filename-id":"cbs-project-projectid-projectcostingsource-get" }, "put":{ "tags":[ "CBS" ], "summary":"Update a Project Costing Source ", "description":"Send a request to this endpoint to update a project cost source. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Update Key : 'projectCostingSourceId'", "operationId":"/cbs/project/{projectId}/projectCostingSource_updateProjectCostingSource", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"UNDEFINED", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectCostingSourceInput", "$ref":"#/components/schemas/ApiEntityProjectCostingSourceInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Costing_Source_Using_Project_Costing_Source":{ "summary":"Update a Project Costing Source Using Project Costing Source", "description":"Payload to update a project costing source using the project costing source ID and the manual budget enabled setting.", "value":{ "projectCostingSourceId":23401, "manualBudgetEnabled":false }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-project-{projectId}-projectCostingSource-put", "x-filename-id":"cbs-project-projectid-projectcostingsource-put" }, "post":{ "tags":[ "CBS" ], "summary":"Create a Project Costing Source", "description":"Send a request to this endpoint to create a project costing source. An application object will be created using the JSON data provided in the request body.", "operationId":"/cbs/project/{projectId}/projectCostingSource_createProjectCostingSource", "parameters":[ { "name":"projectId", "in":"path", "description":"A project costing source object.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"A project costing source object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectCostingSourceInput", "$ref":"#/components/schemas/ApiEntityProjectCostingSourceInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Costing_Source":{ "summary":"Create a Project Costing Source", "description":"Payload to create a project costing source using the actuals source, approved actuals and manual budget enabled setting, budget source, and project ID.", "value":{ "actualsSource":"SCOPE", "approvedActualsEnabled":true, "budgetSource":"SCOPE", "projectId":108201, "manualBudgetEnabled":true }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectCostingSource", "$ref":"#/components/schemas/ApiEntityProjectCostingSource", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-project-{projectId}-projectCostingSource-post", "x-filename-id":"cbs-project-projectid-projectcostingsource-post" } }, "/cbs/createworkspaceCBS":{ "post":{ "tags":[ "CBS" ], "summary":"Create a Workspace CBS", "description":"Send a request to this endpoint to create a workspace CBS. An application object will be created using the JSON data provided in the request body. \nNote: Before you can create a workspace CBS, you must create a workspace CBS segment.", "operationId":"/cbs/createworkspaceCBS_createworkspaceCBS", "requestBody":{ "description":"A CBS object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSTemplateCodeInput", "$ref":"#/components/schemas/ApiEntityCBSTemplateCodeInput", "exampleSetFlag":false }, "examples":{ "Create_a_Workspace_CBS":{ "summary":"Create a Workspace CBS", "description":"Payload to create workspace cbs using the workspace ID, cbs code, description, and cost type.", "value":{ "workspaceId":28001, "cbsCode":"GR", "description":"General Requirement", "costType":"CAPITAL" }, "valueSetFlag":true }, "Create_a_Workspace_CBS_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Workspace CBS that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create workspace cbs using the workspace ID, cbs code, description, cost type, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "workspaceId":28001, "cbsCode":"GR", "description":"General Requirement", "costType":"CAPITAL", "templateRow":{ "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of workspace cbs" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] } }, "valueSetFlag":true }, "Create_a_Workspace_CBS_that_includes_Configured_Field_Text":{ "summary":"Create a Workspace CBS that includes Configured Field Text", "description":"Payload to create workspace cbs using the workspace ID, cbs code, description, cost type, and values for the configured field which include column name and text value.", "value":{ "workspaceId":28001, "cbsCode":"GR", "description":"General Requirement", "costType":"CAPITAL", "templateRow":{ "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of workspace cbs" } ] } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSTemplateCode", "$ref":"#/components/schemas/ApiEntityCBSTemplateCode", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-createworkspaceCBS-post", "x-filename-id":"cbs-createworkspacecbs-post" } }, "/cbs/project/{cbsSheetCodeId}":{ "delete":{ "tags":[ "CBS" ], "summary":"Delete a Project CBS Code by Project CBS ID", "description":"Send a request to this endpoint to delete a project CBS code. The application object with an ID value that matches the value of the {cbsSheetCodeId} path parameter will be deleted.", "operationId":"/cbs/project/{cbsSheetCodeId}_deleteProjectCBS", "parameters":[ { "name":"cbsSheetCodeId", "in":"path", "description":"The system-generated identifier of a CBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-project-{cbsSheetCodeId}-delete", "x-filename-id":"cbs-project-cbssheetcodeid-delete" } }, "/cbs/resetCostSheet/workspace/{workspaceCode}/project/{projectCode}":{ "delete":{ "tags":[ "CBS" ], "summary":"Reset all Project Cost Sheet Code", "description":"Send a request to this endpoint to reset all Project Cost Sheet Codes.", "operationId":"/cbs/resetCostSheet/workspace/{workspaceCode}/project/{projectCode}_deleteProjectTemplate", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified unique identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"path", "description":"Indicate the project code where CBS codes have to be reset.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-resetCostSheet-workspace-{workspaceCode}-project-{projectCode}-delete", "x-filename-id":"cbs-resetcostsheet-workspace-workspacecode-project-projectcode-delete" } }, "/cbs/workspace/{cbsTemplateCodeId}":{ "delete":{ "tags":[ "CBS" ], "summary":"Delete a Workspace CBS Code by Workspace CBS ID", "description":"Send a request to this endpoint to delete a workspace CBS code. The application object with an ID value that matches the value of the {cbsItemId} path parameter will be deleted.", "operationId":"/cbs/workspace/{cbsTemplateCodeId}_deleteWorkspaceCBS", "parameters":[ { "name":"cbsTemplateCodeId", "in":"path", "description":"The system-generated identifier of a CBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-workspace-{cbsTemplateCodeId}-delete", "x-filename-id":"cbs-workspace-cbstemplatecodeid-delete" } }, "/cbs/resetCBSTemplate/workspace/{workspaceCode}":{ "delete":{ "tags":[ "CBS" ], "summary":"Reset Workspace CBS Template", "description":"Send a request to this endpoint to reset all CBS Template Segments and CBS Template Codes under the specified workspace.", "operationId":"/cbs/resetCBSTemplate/workspace/{workspaceCode}_deleteWorkspaceTemplate", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified unique identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "404":{ "description":"The requested workspace does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-resetCBSTemplate-workspace-{workspaceCode}-delete", "x-filename-id":"cbs-resetcbstemplate-workspace-workspacecode-delete" } }, "/cbs/project/externallySourced":{ "get":{ "tags":[ "CBS" ], "summary":"View Integrated CBSs", "description":"This endpoint returns all integrated CBS objects.", "operationId":"/cbs/project/externallySourced_findForSource_1", "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedCBSSheetCode", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-project-externallySourced-get", "x-filename-id":"cbs-project-externallysourced-get" } }, "/cbs/projectCbs/{cbsSheetCodeId}":{ "get":{ "tags":[ "CBS" ], "summary":"View a Project CBS", "description":"This endpoint returns Project CBS code that meet the following requirements:
  • The object has an ID that matches the value of the {cbsSheetCodeId} path parameter.
A CBS is used to track, manage, and report costs related to a project.", "operationId":"/cbs/projectCbs/{cbsSheetCodeId}_findProjectCbs", "parameters":[ { "name":"cbsSheetCodeId", "in":"path", "description":"The system-generated identifier of a CBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "200":{ "description":"Returns the project CBS for the specified project CBS ID", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSSheetCode", "$ref":"#/components/schemas/ApiEntityCBSSheetCode", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "404":{ "description":"The requested object does not exist, or you do not have access to it." } }, "x-internal-id":"cbs-projectCbs-{cbsSheetCodeId}-get", "x-filename-id":"cbs-projectcbs-cbssheetcodeid-get" } }, "/cbs/workspaceCbs/{cbsTemplateCodeId}":{ "get":{ "tags":[ "CBS" ], "summary":"View a Workspace CBS", "description":"This endpoint returns Workspace CBS code that meet the following requirements:
  • The object has an ID that matches the value of the {cbsTemplateCodeId} path parameter.
A CBS is used to track, manage, and report costs related to a project.", "operationId":"/cbs/workspaceCbs/{cbsTemplateCodeId}_findWorkspaceCbs", "parameters":[ { "name":"cbsTemplateCodeId", "in":"path", "description":"The system-generated identifier of a CBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "200":{ "description":"Returns the workspace CBS for the specified workspace CBS ID", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSTemplateCode", "$ref":"#/components/schemas/ApiEntityCBSTemplateCode", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "404":{ "description":"The requested object does not exist, or you do not have access to it." } }, "x-internal-id":"cbs-workspaceCbs-{cbsTemplateCodeId}-get", "x-filename-id":"cbs-workspacecbs-cbstemplatecodeid-get" } }, "/cbs/workspace/byParent":{ "get":{ "tags":[ "CBS" ], "summary":"View all workspace CBSs by parent code", "description":"Send a request to this endpoint to view all workspace CBSs under parent with codes matching the code fields in query parameters.", "operationId":"/cbs/workspace/byParent_getAllCBSByWorkspaceCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the workspace CBSs have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSTemplateCode", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-workspace-byParent-get", "x-filename-id":"cbs-workspace-byparent-get" } }, "/cbs/project/byParent":{ "get":{ "tags":[ "CBS" ], "summary":"View all project CBSs by parent code", "description":"Send a request to this endpoint to view all project CBSs under parent with codes matching the code fields in query parameters.", "operationId":"/cbs/project/byParent_getAllCBSByWorkspaceCodeAndProjectCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the project CBSs have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code under which all the project CBSs have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetCode", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-project-byParent-get", "x-filename-id":"cbs-project-byparent-get" } }, "/cbs/project/{projectId}/code/{cbsCode}":{ "get":{ "tags":[ "CBS" ], "summary":"View a CBS Sheet Code by Project and CBS Code", "description":"This endpoint returns CBS sheet codes that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a cbs code with a value that matches the value of the {cbsCode} path parameter.
A CBS is used to track, manage, and report costs related to a project.", "operationId":"/cbs/project/{projectId}/code/{cbsCode}_getCBSCodeByProjectAndCode", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"cbsCode", "in":"path", "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetCode", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-project-{projectId}-code-{cbsCode}-get", "x-filename-id":"cbs-project-projectid-code-cbscode-get" } }, "/cbs/project/{projectId}":{ "get":{ "tags":[ "CBS" ], "summary":"View all Project CBS Assigned to a Project", "description":"This endpoint returns CBS codes that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
A CBS is used to track, manage, and report costs related to a project.", "operationId":"/cbs/project/{projectId}_getProjectCodes", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a CBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetCode", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-project-{projectId}-get", "x-filename-id":"cbs-project-projectid-get" } }, "/cbs/project/{projectId}/totalCost":{ "get":{ "tags":[ "CBS" ], "summary":"View a CBS Sheet Total Cost Row by Project", "description":"This endpoint returns CBS sheet total cost rows that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
A CBS is used to track, manage, and report costs related to a project.", "operationId":"/cbs/project/{projectId}/totalCost_getTotalCostByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetCode", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-project-{projectId}-totalCost-get", "x-filename-id":"cbs-project-projectid-totalcost-get" } }, "/cbs/workspace/byItemCode":{ "get":{ "tags":[ "CBS" ], "summary":"View a workspace CBS by code", "description":"Send a request to this endpoint to view a workspace CBS with codes matching the code fields in query parameters.", "operationId":"/cbs/workspace/byItemCode_getWorkspaceCBSCodeByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the workspace CBS to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"cbsCode", "in":"query", "description":"CBS code of the workspace CBS to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSTemplateCode", "$ref":"#/components/schemas/ApiEntityCBSTemplateCode", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-workspace-byItemCode-get", "x-filename-id":"cbs-workspace-byitemcode-get" } }, "/cbs/workspace/{workspaceId}":{ "get":{ "tags":[ "CBS" ], "summary":"View all Workspace CBS Codes Assigned to a Workspace", "description":"This endpoint returns CBS codes that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
A CBS is used to track, manage, and report costs related to a project.", "operationId":"/cbs/workspace/{workspaceId}_getWorkspaceCodes", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSTemplateCode", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-workspace-{workspaceId}-get", "x-filename-id":"cbs-workspace-workspaceid-get" } }, "/cbs/aggregate/reference/{referenceObjectId}":{ "get":{ "tags":[ "CBS" ], "summary":"View a Workspace Total Item by ID and Template Type", "description":"This endpoint returns workspace total items that meet the following requirements:
  • The object has a reference to another object with an ID value that matches the value of the {referenceObjectId} path parameter.
  • The object has a template with a type that matches one or more values of the {templateType} query parameter.
A CBS is used to track, manage, and report costs related to a project.", "operationId":"/cbs/aggregate/reference/{referenceObjectId}_getWorkspaceTotalItem", "parameters":[ { "name":"referenceObjectId", "in":"path", "description":"The unique identifier of the project or workspace that owns the cost values.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"templateType", "in":"query", "description":"The Rollup type for workspace total item.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE", "PROJECT" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceTotalItem", "$ref":"#/components/schemas/ApiEntityWorkspaceTotalItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-aggregate-reference-{referenceObjectId}-get", "x-filename-id":"cbs-aggregate-reference-referenceobjectid-get" } }, "/cbs/import/workspaceCbs/{cbsTemplateCodeId}/program/{programId}":{ "put":{ "tags":[ "CBS" ], "summary":"Import a Workspace CBS to a Program", "description":"Send a request to this end point to import a workspace cbs to a program. ", "operationId":"/cbs/import/workspaceCbs/{cbsTemplateCodeId}/program/{programId}_importWorkspaceCbsToAProgram", "parameters":[ { "name":"cbsTemplateCodeId", "in":"path", "description":"The user-specified identifier of a workspace cbs that needs to be imported.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"programId", "in":"path", "description":"The user-specified identifier of a program to which the workspace cbs is to be imported.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The given cbsTemplateCodeId or programId doesn't exist or has been deleted." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-import-workspaceCbs-{cbsTemplateCodeId}-program-{programId}-put", "x-filename-id":"cbs-import-workspacecbs-cbstemplatecodeid-program-programid-put" } }, "/cbs/recalculate/program/{programId}":{ "post":{ "tags":[ "CBS", "Program", "Action" ], "summary":"Recalculate Program Cost Sheet", "description":"Send a request to this endpoint to recalculate program cost sheet for the given program ID.", "operationId":"/cbs/recalculate/program/{programId}_recalculateProgramCostSheet", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-recalculate-program-{programId}-post", "x-filename-id":"cbs-recalculate-program-programid-post" } }, "/cbs/recalculate/project/{projectId}":{ "post":{ "tags":[ "CBS", "Project", "Action" ], "summary":"Recalculate Project Cost Sheet", "description":"Send a request to this endpoint to recalculate project cost sheet for the given project ID.", "operationId":"/cbs/recalculate/project/{projectId}_recalculateProjectCostSheet", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"Cost Types to include in project cost sheet recalculation.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTUALS", "BUDGET", "COMMITMENTS", "CONTRACTS", "RISKS", "SCOPE", "FORMULA_CONFIGURED_FIELDS" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-recalculate-project-{projectId}-post", "x-filename-id":"cbs-recalculate-project-projectid-post" } }, "/cbs/recalculate/workspace/{workspaceId}":{ "post":{ "tags":[ "CBS", "Workspace", "Action" ], "summary":"Recalculate Workspace Cost Sheet", "description":"Send a request to this endpoint to recalculate workspace cost sheet for the given workspace ID.", "operationId":"/cbs/recalculate/workspace/{workspaceId}_recalculateWorkspaceCostSheet", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"Request entity with workspace or project recalculation options. ", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRecalculateWorkspaceCostSheetInput", "$ref":"#/components/schemas/ApiEntityRecalculateWorkspaceCostSheetInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-recalculate-workspace-{workspaceId}-post", "x-filename-id":"cbs-recalculate-workspace-workspaceid-post" } }, "/cbs/resetProgramCBS/program/{programId}":{ "delete":{ "tags":[ "CBS" ], "summary":"Reset all Program CBS Template Codes", "description":"Send a request to this endpoint to reset all the CBS Template Codes imported into a program.", "operationId":"/cbs/resetProgramCBS/program/{programId}_resetProgramCbs", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-resetProgramCBS-program-{programId}-delete", "x-filename-id":"cbs-resetprogramcbs-program-programid-delete" } }, "/cbs/project/sync":{ "post":{ "tags":[ "CBS" ], "summary":"Integrate a CBS with an External Data Source", "description":"Send a request to this endpoint to create or update an integrated a CBS. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/cbs/project/sync_sync_1", "requestBody":{ "description":"The unique identifier of CBS data in an external source.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedCBSSheetCodeInput", "$ref":"#/components/schemas/ApiEntityExternallySourcedCBSSheetCodeInput", "exampleSetFlag":false }, "examples":{ "Create_or_Update_CBSs":{ "summary":"Create or Update CBSs", "description":"Payload to create or update an integrated CBS using project ID, cbs code, and description.", "value":{ "projectId":32101, "cbsCode":"CONR", "description":"Concrete" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-project-sync-post", "x-filename-id":"cbs-project-sync-post" } }, "/cbs/project/syncBatch":{ "post":{ "tags":[ "CBS" ], "summary":"Batch Integrate CBSs with an External Data Source", "description":"Send a request to this endpoint to create or update one or more integrated CBSs. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/cbs/project/syncBatch_syncBatch_10", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any CBS sheet codes sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"The unique identifier of CBS data in an external source.S", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedCBSSheetCodeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_CBS_to_Assign_a_Configured_Field":{ "summary":"Create or Update a CBS to Assign a Configured Field", "description":"Payload to create or update a CBS using project ID, CBS code, description, cbs sheet code ID, and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "projectId":32101, "cbsCode":"CONR", "description":"Concrete", "costSheetRow":{ "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of project cbs" }, { "columnDefinationId":60145, "textValue":"Y" } ] } }, { "cbsSheetCodeId":34103, "costSheetRow":{ "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of project cbs" }, { "columnDefinationId":60145, "numberValue":5 } ] } } ], "valueSetFlag":true }, "Create_or_Update_the_CBS_using_the_Parent_CBS_Codes":{ "summary":"Create or Update the CBS using the Parent CBS Codes", "description":"Payload to create or update one or more CBSs using project IDs, CBS codes, descriptions, and parent CBS codes to create a hierarchy structure for CBSs.", "value":[ { "projectId":32101, "cbsCode":"CL", "description":"Concrete Labor", "parentCBSCodes":[ "CON" ] } ], "valueSetFlag":true }, "Create_or_Update_a_CBS_using_the_CBS_Code":{ "summary":"Create or Update a CBS using the CBS Code", "description":"Payload to create or update a CBS using project ID, CBS code, and description.", "value":[ { "projectId":32101, "cbsCode":"CONR", "description":"Concrete" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"cbs-project-syncBatch-post", "x-filename-id":"cbs-project-syncbatch-post" } }, "/cbs/project":{ "put":{ "tags":[ "CBS" ], "summary":"Update a Project CBS Code by CBS ", "description":"Send a request to this endpoint to update a project CBS code. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Update Key : 'cbsSheetCodeId'", "operationId":"/cbs/project_updateProject", "requestBody":{ "description":"A CBS object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSSheetCodeInput", "$ref":"#/components/schemas/ApiEntityCBSSheetCodeInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_CBS_by_Removing_a_Configured_Field":{ "summary":"Update a Project CBS by Removing a Configured Field", "description":"Payload to update the cbs sheet code ID and specifying the action and column label for the configured field to be removed.", "value":{ "cbsSheetCodeId":34103, "costSheetRow":{ "configuredFields":[ { "action":"DELETE", "columnLabel":"COST_ADDED" } ] } }, "valueSetFlag":true }, "Update_a_Project_CBS_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Project CBS to Assign a Boolean Configured Field", "description":"Payload to update the cbs sheet code ID and configured field column label and text value.", "value":{ "cbsSheetCodeId":34103, "costSheetRow":{ "configuredFields":[ { "columnLabel":"COST_ADDED", "textValue":"Y" } ] } }, "valueSetFlag":true }, "Update_a_Project_CBS_Code_Using_CBS_Sheet_Code_ID":{ "summary":"Update a Project CBS Code Using CBS Sheet Code ID", "description":"Payload to update the description using the cbs sheet code ID.", "value":{ "description":"Exterior Improvements", "cbsSheetCodeId":34103 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-project-put", "x-filename-id":"cbs-project-put" } }, "/cbs/workspace":{ "put":{ "tags":[ "CBS" ], "summary":"Update a Workspace CBS Code", "description":"Send a request to this endpoint to update a workpsace CBS code. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Update Key : 'cbsTemplateCodeId'", "operationId":"/cbs/workspace_updateWorkspace", "requestBody":{ "description":"A CBS object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSTemplateCodeInput", "$ref":"#/components/schemas/ApiEntityCBSTemplateCodeInput", "exampleSetFlag":false }, "examples":{ "Update_a_Workspace_by_Removing_a_Configured_Field":{ "summary":"Update a Workspace by Removing a Configured Field", "description":"Payload to update the cbs template code ID and specifying the action and column label for the configured field to be removed.", "value":{ "cbsTemplateCodeId":2001, "templateRow":{ "configuredFields":[ { "action":"DELETE", "columnLabel":"COST_ADDED" } ] } }, "valueSetFlag":true }, "Update_a_Workspace_CBS_Code_Using_CBS_Template_Code_ID":{ "summary":"Update a Workspace CBS Code Using CBS Template Code ID", "description":"Payload to update the description using the cbs template code ID.", "value":{ "cbsTemplateCodeId":2001, "description":"General Requirements" }, "valueSetFlag":true }, "Update_a_Workspace_CBS_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Workspace CBS to Assign a Boolean Configured Field", "description":"Payload to update the cbs template code ID and configured field column label and text value.", "value":{ "cbsTemplateCodeId":2001, "templateRow":{ "configuredFields":[ { "columnLabel":"COST_ADDED", "textValue":"Y" } ] } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"cbs-workspace-put", "x-filename-id":"cbs-workspace-put" } }, "/calendar":{ "put":{ "tags":[ "Calendar" ], "summary":"Update a Calendar", "description":"Send a request to this endpoint to update a calendar. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/calendar_update_10", "requestBody":{ "description":"A calendar object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCalendarInput", "$ref":"#/components/schemas/ApiEntityCalendarInput", "exampleSetFlag":false }, "examples":{ "Update_a_Calendar_Using_Calendar_ID":{ "summary":"Update a Calendar Using Calendar ID", "description":"Payload to update the name of a calendar using calendar ID.", "value":{ "calendarCode":"National Calendar ", "calendarName":"National Calendar - 2023", "calendarId":1001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"calendar-put", "x-filename-id":"calendar-put" }, "post":{ "tags":[ "Calendar" ], "summary":"Create a Calendar", "description":"Send a request to this endpoint to create a calendar. An application object will be created using the JSON data provided in the request body.", "operationId":"/calendar_create_11", "requestBody":{ "description":"A calendar object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCalendarInput", "$ref":"#/components/schemas/ApiEntityCalendarInput", "exampleSetFlag":false }, "examples":{ "Create_a_Calendar":{ "summary":"Create a Calendar", "description":"Payload to create a calendar using workspace ID, calender code, calender name, work time for Monday, work time for Tuesday, work time for Wednesday, work time for Thursday, work time for Friday, work time for Saturday, and work time for Sunday.", "value":{ "calendarCode":"Global Calendar ", "calendarName":"Global Calendar", "workTimeMonday":"000000000000001111111111111111111100000000000000", "workTimeTuesday":"000000000000001111111111111111111100000000000000", "workTimeWednesday":"000000000000001111111111111111111100000000000000", "workTimeThursday":"000000000000001111111111111111111100000000000000", "workTimeFriday":"000000000000000000000000000000000000000000000000", "workTimeSaturday":"000000000000000000000000000000000000000000000000", "workTimeSunday":"000000000000000000000000000000000000000000000000", "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCalendar", "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-post", "x-filename-id":"calendar-post" } }, "/calendar/batch":{ "put":{ "tags":[ "Calendar" ], "summary":"Batch Update Calendars", "description":"Send a request to this endpoint to update one or more calendars. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/calendar/batch_updateBatch_10", "requestBody":{ "description":"One or more calendar objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendarInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Calendars_Using_Calendar_IDs":{ "summary":"Batch Update Calendars Using Calendar IDs", "description":"Payload to update the name of one or more calendars using calendar IDs.", "value":[ { "calendarCode":"National Calendar ", "calendarName":"National Calendar - 2023", "calendarId":1001 }, { "calendarCode":"Organization Calendar ", "calendarName":"Organization Calendar - 2023", "calendarId":1002 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"calendar-batch-put", "x-filename-id":"calendar-batch-put" }, "post":{ "tags":[ "Calendar" ], "summary":"Batch Create Calendars", "description":"Send a request to this endpoint to create one or more calendars. An application object will be created for each JSON object provided in the request body.", "operationId":"/calendar/batch_createBatch_11", "requestBody":{ "description":"One or more calendar objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendarInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Calendars":{ "summary":"Batch Create Calendars", "description":"Payload to create one or more calendars using workspace ID, calender code, calender name, work time for Monday, work time for Tuesday, work time for Wednesday, work time for Thursday, work time for Friday, work time for Saturday, and work time for Sunday.", "value":[ { "calendarCode":"National Calendar ", "calendarName":"National Calendar", "workTimeMonday":"000000000000001111111111111111111100000000000000", "workTimeTuesday":"000000000000001111111111111111111100000000000000", "workTimeWednesday":"000000000000001111111111111111111100000000000000", "workTimeThursday":"000000000000001111111111111111111100000000000000", "workTimeFriday":"000000000000000000000000000000000000000000000000", "workTimeSaturday":"000000000000000000000000000000000000000000000000", "workTimeSunday":"000000000000000000000000000000000000000000000000", "workspaceId":10001 }, { "calendarCode":"Organization Calendar ", "calendarName":"Organization Calendar", "workTimeMonday":"000000000000001111111111111111111100000000000000", "workTimeTuesday":"000000000000001111111111111111111100000000000000", "workTimeWednesday":"000000000000000000000000000000000000000000000000", "workTimeThursday":"000000000000001111111111111111111100000000000000", "workTimeFriday":"000000000000000000000000000000000000000000000000", "workTimeSaturday":"000000000000000000000000000000000000000000000000", "workTimeSunday":"000000000000000000000000000000000000000000000000", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-batch-post", "x-filename-id":"calendar-batch-post" }, "delete":{ "tags":[ "Calendar" ], "summary":"Batch Delete Calendars", "description":"Send a request to this endpoint to delete one or more calendars. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/calendar/batch_deleteBatch_10", "requestBody":{ "description":"One or more system-generated identifiers of calendars.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"calendar-batch-delete", "x-filename-id":"calendar-batch-delete" } }, "/calendar/{calendarId}":{ "get":{ "tags":[ "Calendar" ], "summary":"View a Calendar", "description":"This endpoint returns calendars that meet the following requirements:
  • The object is associated with a calendar with an ID value that matches the value of the {calendarId} path parameter.
Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles.", "operationId":"/calendar/{calendarId}_find_11", "parameters":[ { "name":"calendarId", "in":"path", "description":"The system-generated identifier of a calendar.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested calendar does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCalendar", "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-{calendarId}-get", "x-filename-id":"calendar-calendarid-get" }, "delete":{ "tags":[ "Calendar" ], "summary":"Delete a Calendar", "description":"Send a request to this endpoint to delete a calendar. The application object with an ID value that matches the value of the {calendarId} path parameter will be deleted.", "operationId":"/calendar/{calendarId}_delete_10", "parameters":[ { "name":"calendarId", "in":"path", "description":"The system-generated identifier of a calendar.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"calendar-{calendarId}-delete", "x-filename-id":"calendar-calendarid-delete" } }, "/calendar/code/{calendarCode}":{ "get":{ "tags":[ "Calendar" ], "summary":"View Calendars by Code", "description":"This endpoint returns calendars that meet the following requirements:
  • The object has a code that matches the value of the {calendarCode} path parameter.
Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles.", "operationId":"/calendar/code/{calendarCode}_findByCode_3", "parameters":[ { "name":"calendarCode", "in":"path", "description":"The user-specified identifier of a calendar.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"calendarType", "in":"query", "description":"Type of Calendar - Workspace or Project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "default":"WORKSPACE", "enum":[ "WORKSPACE", "PROJECT" ] } } ], "responses":{ "404":{ "description":"The requested calendar does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-code-{calendarCode}-get", "x-filename-id":"calendar-code-calendarcode-get" } }, "/calendar/workspace/{workspaceId}/code/{calendarCode}":{ "get":{ "tags":[ "Calendar" ], "summary":"View a Calendar by Code and Workspace ID", "description":"This endpoint returns calendars that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
  • The object has a code that matches the value of the {calendarCode} path parameter.
Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles.", "operationId":"/calendar/workspace/{workspaceId}/code/{calendarCode}_findByCodeAndWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"calendarCode", "in":"path", "description":"The user-specified identifier of a calendar.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested calendar does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCalendar", "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-workspace-{workspaceId}-code-{calendarCode}-get", "x-filename-id":"calendar-workspace-workspaceid-code-calendarcode-get" } }, "/calendar/exception/{calendarId}":{ "get":{ "tags":[ "Calendar" ], "summary":"View Calendar Exceptions", "description":"This endpoint returns calendar exceptions that meet the following requirements:
  • The object is associated with a calendar with an ID value that matches the value of the {calendarId} path parameter.
Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles.", "operationId":"/calendar/exception/{calendarId}_findExceptions", "parameters":[ { "name":"calendarId", "in":"path", "description":"The system-generated identifier of a calendar exception.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested calendar exception does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendarException", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-exception-{calendarId}-get", "x-filename-id":"calendar-exception-calendarid-get" } }, "/calendar/byParent":{ "get":{ "tags":[ "Calendar" ], "summary":"View all Workspace Calendars by Parent", "description":"Send a request to this endpoint to view all workspace level calendars under parent with codes matching the code fields in query parameters.", "operationId":"/calendar/byParent_getAllCalendarsByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the calendars have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-byParent-get", "x-filename-id":"calendar-byparent-get" } }, "/calendar/byItemCode":{ "get":{ "tags":[ "Calendar" ], "summary":"View a Workspace Calendar by Code and Parent Code", "description":"Send a request to this endpoint to view a workspace level calendar with codes matching the code fields in query parameters.", "operationId":"/calendar/byItemCode_getCalendarByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the calendar to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"calendarCode", "in":"query", "description":"Calendar code of the calendar to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCalendar", "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-byItemCode-get", "x-filename-id":"calendar-byitemcode-get" } }, "/calendar/project/code":{ "get":{ "tags":[ "Calendar" ], "summary":"View Calendars by Project and Workspace Code", "description":"Send a request to this endpoint to view all project specific calendars under a project identified by the provided codes.", "operationId":"/calendar/project/code_getCalendarsByProjectCodes", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the calendar to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested calendar does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-project-code-get", "x-filename-id":"calendar-project-code-get" } }, "/calendar/project/{projectId}":{ "get":{ "tags":[ "Calendar" ], "summary":"View Calendars by Project", "description":"Send a request to this endpoint to get all the project specific calendars under the provided projectId.", "operationId":"/calendar/project/{projectId}_getCalendarsByProjectId", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested calendar does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-project-{projectId}-get", "x-filename-id":"calendar-project-projectid-get" } }, "/calendar/workspace/{workspaceId}":{ "get":{ "tags":[ "Calendar" ], "summary":"View Calendars by Workspace", "description":"This endpoint returns calendars that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles.", "operationId":"/calendar/workspace/{workspaceId}_getCalendarsByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested calendar does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-workspace-{workspaceId}-get", "x-filename-id":"calendar-workspace-workspaceid-get" } }, "/calendar/defaultCalendar/workspace/{workspaceId}":{ "get":{ "tags":[ "Calendar" ], "summary":"View Default Workspace Calendar", "description":"This endpoint returns workspace default calendars that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Calendars define the workdays, work hours, holidays, and exceptions available to projects, resources, and roles.", "operationId":"/calendar/defaultCalendar/workspace/{workspaceId}_getDefaultCalendarByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested calendar does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCalendar", "$ref":"#/components/schemas/ApiEntityCalendar", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-defaultCalendar-workspace-{workspaceId}-get", "x-filename-id":"calendar-defaultcalendar-workspace-workspaceid-get" } }, "/calendar/promote":{ "put":{ "tags":[ "Calendar" ], "summary":"Promote Project Calendars To Workspace", "description":"Send a request to this endpoint to promote the project calendars provided in the payload to their immediate workspaces.", "operationId":"/calendar/promote_promoteProjectCalendars", "requestBody":{ "description":"List of project calendars.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPromoteProjectCalendar", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Promote_Project_Calendar_to_Parent_Workspace":{ "summary":"Promote Project Calendar to Parent Workspace", "description":"Payload to promote a project calendar to the immediate parent workspace using calendar ID or combination of project ID, and calendar code.", "value":[ { "calendarId":1 }, { "projectId":1001, "calendarCode":"Organization Calender - 2023" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"calendar-promote-put", "x-filename-id":"calendar-promote-put" } }, "/calendar/syncBatch":{ "post":{ "tags":[ "Calendar" ], "summary":"Batch Sync Calendars", "description":"Send a request to this endpoint to create or update one or more calendars.", "operationId":"/calendar/syncBatch_syncBatch_11", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any calendar sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more calendar objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendarInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Calendar_for_a_Project":{ "summary":"Create or Update Calendar for a Project", "description":"Payload to create or update a calendar using workspace ID, project ID, calendar code, calendar name and worktime for all days of the week.", "value":[ { "calendarCode":"Global Calendar ", "calendarName":"Global Calendar", "workTimeMonday":"000000000000001111111111111111111100000000000000", "workTimeTuesday":"000000000000001111111111111111111100000000000000", "workTimeWednesday":"000000000000001111111111111111111100000000000000", "workTimeThursday":"000000000000001111111111111111111100000000000000", "workTimeFriday":"000000000000000000000000000000000000000000000000", "workTimeSaturday":"000000000000000000000000000000000000000000000000", "workTimeSunday":"000000000000000000000000000000000000000000000000", "workspaceId":10001, "projectId":22101 } ], "valueSetFlag":true }, "Create_or_Update_Calendar_for_a_Workspace":{ "summary":"Create or Update Calendar for a Workspace", "description":"Payload to create or update a calendar using workspace ID, calendar code, calendar name and worktime for all days of the week.", "value":[ { "calendarCode":"Global Calendar ", "calendarName":"Global Calendar", "workTimeMonday":"000000000000001111111111111111111100000000000000", "workTimeTuesday":"000000000000001111111111111111111100000000000000", "workTimeWednesday":"000000000000001111111111111111111100000000000000", "workTimeThursday":"000000000000001111111111111111111100000000000000", "workTimeFriday":"000000000000000000000000000000000000000000000000", "workTimeSaturday":"000000000000000000000000000000000000000000000000", "workTimeSunday":"000000000000000000000000000000000000000000000000", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"calendar-syncBatch-post", "x-filename-id":"calendar-syncbatch-post" } }, "/calendarExceptions/{calendarExceptionId}":{ "delete":{ "tags":[ "Calendar Exception" ], "summary":"Delete a Calendar Exception", "description":"Send a request to this endpoint to delete a calendar exception. The application object with an ID value that matches the value of the {calendarExceptionId} path parameter will be deleted.", "operationId":"/calendarExceptions/{calendarExceptionId}_delete_11", "parameters":[ { "name":"calendarExceptionId", "in":"path", "description":"The system-generated identifier of a calendar exception.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for a calendar exception. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"calendarExceptions-{calendarExceptionId}-delete", "x-filename-id":"calendarexceptions-calendarexceptionid-delete" } }, "/calendarExceptions/batch":{ "delete":{ "tags":[ "Calendar Exception" ], "summary":"Batch Delete Calendar Exceptions", "description":"Send a request to this endpoint to delete one or more calendar exceptions. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/calendarExceptions/batch_deleteBatch_11", "requestBody":{ "description":"One or more system-generated identifiers of calendar exception.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a calendar exception. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"calendarExceptions-batch-delete", "x-filename-id":"calendarexceptions-batch-delete" } }, "/portfolio/assignUser":{ "post":{ "tags":[ "Portfolio" ], "summary":"Assign Permission Profiles To User", "description":"Send a request to this endpoint to view the user's permission sets for the provided portfolio.", "operationId":"/portfolio/assignUser_assignUser", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail to successfully complete the request if an error occurred when validating any user permission profile sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with portfolio and user profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioUserPermissions", "$ref":"#/components/schemas/ApiEntityPortfolioUserPermissions", "exampleSetFlag":false }, "examples":{ "Assign_Portfolio_Permission_Profiles_to_Multiple_Users_Using_IDs":{ "summary":"Assign Portfolio Permission Profiles to Multiple Users Using IDs", "description":"Payload to assign portfolio permission to multiple users using mandatory fields such as portfolio ID, user name, and portfolio profile ID.", "value":{ "portfolioId":22001, "profiles":[ { "userName":"supervisor@example.com", "portfolioProfileId":"4" }, { "userName":"manager@example.com", "portfolioProfileId":"4" } ] }, "valueSetFlag":true }, "Assign_Portfolio_Permission_Profiles_to_Multiple_Users_Using_Codes":{ "summary":"Assign Portfolio Permission Profiles to Multiple Users Using Codes", "description":"Payload to assign portfolio permission to multiple users using workspace ID, portfolio name, and profiles such as user name, file profile ID, portfolio profile ID, and report profile ID.", "value":{ "portfolioName":"Roadways Proposal", "workspaceId":1739401, "profiles":[ { "userName":"supervisor@example.com", "portfolioProfileId":"4", "fileProfileId":"6", "reportProfileId":"7" }, { "userName":"manager@example.com", "portfolioProfileId":"4", "fileProfileId":"6", "reportProfileId":"7" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the capital portfolio service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityPortfolioUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-assignUser-post", "x-filename-id":"portfolio-assignuser-post" } }, "/portfolio":{ "put":{ "tags":[ "Portfolio" ], "summary":"Update a Portfolio", "description":"Send a request to this endpoint to update a portfolio. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/portfolio_update_11", "requestBody":{ "description":"A portfolio object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioInput", "$ref":"#/components/schemas/ApiEntityPortfolioInput", "exampleSetFlag":false }, "examples":{ "Update_a_Portfolio":{ "summary":"Update a Portfolio", "description":"Payload to update description of a portfolio using the portfolio ID.", "value":{ "description":"Roadways Proposal List 2023", "portfolioId":826401 }, "valueSetFlag":true }, "Update_a_Portfolio_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Portfolio by Assigning Code Values Using Codes", "description":"Payload to update a portfolio using the portfolio name, workspace code, and codeValuesPortfolio fields such as code value code and code type code.", "value":{ "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "codeValuesPortfolio":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_Portfolio_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Portfolio by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update a portfolio using the portfolio ID and codeValuesPortfolio fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "portfolioId":1114706, "codeValuesPortfolio":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Update_a_Portfolio_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Portfolio by Assigning Multiple Code Values Using IDs", "description":"Payload to update a portfolio using the portfolio ID and codeValuesPortfolio fields such as code value ID and code type ID.", "value":{ "portfolioId":1114706, "codeValuesPortfolio":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Update_a_Portfolio_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Portfolio by Assigning Code Values Using IDs", "description":"Payload to update a portfolio using the portfolio ID and codeValuesPortfolio fields such as code value ID and code type ID.", "value":{ "portfolioId":1114706, "codeValuesPortfolio":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Portfolio_by_Removing_a_Configured_Field":{ "summary":"Update a Portfolio by Removing a Configured Field", "description":"Payload to update the portfolio using the portfolio ID and specifying the action and column label for the configured field to be removed.", "value":{ "portfolioId":826401, "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true }, "Update_a_Portfolio_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Portfolio to Assign a Boolean Configured Field", "description":"Payload to update the portfolio using the portfolio ID and configured field column label and text value.", "value":{ "portfolioId":826401, "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the capital portfolio service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"portfolio-put", "x-filename-id":"portfolio-put" }, "post":{ "tags":[ "Portfolio" ], "summary":"Create a Portfolio", "description":"Send a request to this endpoint to create a portfolio. An application object will be created using the JSON data provided in the request body.", "operationId":"/portfolio_create_12", "requestBody":{ "description":"A portfolio object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioInput", "$ref":"#/components/schemas/ApiEntityPortfolioInput", "exampleSetFlag":false }, "examples":{ "Create_a_Portfolio":{ "summary":"Create a Portfolio", "description":"Payload to create a portfolio using the workspace ID, portfolio name, years planned in year, years planned in quarter, years planned in month, and description.", "value":{ "name":"Roadways Proposal", "workspaceId":1525101, "description":"Roadways Proposal 2023", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2 }, "valueSetFlag":true }, "Create_a_Portfolio_Using_Codes":{ "summary":"Create a Portfolio Using Codes", "description":"Payload to create a portfolio using the workspace code, portfolio name, years planned in year, years planned in quarter, years planned in month, and description.", "value":{ "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "description":"Roadways Proposal 2023", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2 }, "valueSetFlag":true }, "Create_a_Portfolio_that_includes_Configured_Field_Text":{ "summary":"Create a Portfolio that includes Configured Field Text", "description":"Payload to create a portfolio using the workspace ID, portfolio name, years planned in year, years planned in quarter, years planned in month, description, and and values for the configured field which include column name and text value.", "value":{ "name":"Roadways Proposal", "workspaceId":1525101, "description":"Roadways Proposal 2023", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio notes" } ] }, "valueSetFlag":true }, "Create_a_Portfolio_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Portfolio that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a portfolio using the workspace ID, portfolio name, years planned in year, years planned in quarter, years planned in month, description, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "name":"Roadways Proposal", "workspaceId":1525101, "description":"Roadways Proposal 2023", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Portfolio_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Portfolio by Assigning Multiple Code Values Using IDs", "description":"Payload to create a portfolio using the workspace code, portfolio name, years planned in year, years planned in quarter, years planned in month, and codeValuesPortfolio fields such as code value ID and code type ID.", "value":{ "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "codeValuesPortfolio":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Portfolio_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Portfolio by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a portfolio using the workspace code, portfolio name, years planned in year, years planned in quarter, years planned in month, and codeValuesPortfolio fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "codeValuesPortfolio":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Create_a_Portfolio_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create a Portfolio by Assigning Code Values Using IDs", "description":"Payload to create a portfolio using the workspace code, portfolio name, years planned in year, years planned in quarter, years planned in month, and codeValuesPortfolio fields such as code value ID and code type ID.", "value":{ "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "codeValuesPortfolio":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Create_a_Portfolio_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Portfolio by Assigning Code Values Using Codes", "description":"Payload to create a portfolio using the workspace code, portfolio name, years planned in year, years planned in quarter, years planned in month, and codeValuesPortfolio fields such as code value code and code type code.", "value":{ "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "codeValuesPortfolio":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the capital portfolio service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolio", "$ref":"#/components/schemas/ApiEntityPortfolio", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-post", "x-filename-id":"portfolio-post" } }, "/portfolio/batch":{ "put":{ "tags":[ "Portfolio" ], "summary":"Batch Update Portfolios", "description":"Send a request to this endpoint to update one or more portfolios. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/portfolio/batch_updateBatch_11", "requestBody":{ "description":"A list of portfolio objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Portfolios":{ "summary":"Batch Update Portfolios", "description":"Payload to update descriptions of one or more portfolios using the portfolio IDs.", "value":[ { "description":"IT Projects List 2023", "portfolioId":826403 }, { "description":"Manufacturing Projects List 2023", "portfolioId":826404 } ], "valueSetFlag":true }, "Batch_Update_Portfolios_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Portfolios by Assigning Code Values Using Codes or IDs", "description":"Payload to update portfolios using the portfolio ID and codeValuesPortfolio fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "codeValuesPortfolio":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "portfolioId":436446 }, { "codeValuesPortfolio":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "portfolioId":436447 } ], "valueSetFlag":true }, "Batch_Update_Portfolios_to_Assign_Configured_Field":{ "summary":"Batch Update Portfolios to Assign Configured Field", "description":"Payload to update the one or more portfolios using the portfolio IDs and and configured field column name, column label, column definition ID, and text value.", "value":[ { "portfolioId":826403, "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "portfolioId":826404, "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio notes" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true }, "Batch_Update_Portfolios_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Portfolios by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update portfolios using the portfolio ID and codeValuesPortfolio fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesPortfolio":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "portfolioId":436446 }, { "codeValuesPortfolio":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "portfolioId":436447 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the capital portfolio service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"portfolio-batch-put", "x-filename-id":"portfolio-batch-put" }, "post":{ "tags":[ "Portfolio" ], "summary":"Batch Create Portfolios", "description":"Send a request to this endpoint to create one or more portfolios. An application object will be created for each JSON object provided in the request body.", "operationId":"/portfolio/batch_createBatch_12", "requestBody":{ "description":"A list of portfolio objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Portfolios_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Portfolios by Assigning Code Values Using Codes", "description":"Payload to create portfolios using the workspace code, portfolio name, years planned in year, years planned in quarter, years planned in month, and codeValuesPortfolio fields such as code value code and code type code.", "value":[ { "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "codeValuesPortfolio":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ] }, { "name":"IT Portfolio", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "codeValuesPortfolio":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ] } ], "valueSetFlag":true }, "Batch_Create_Portfolios":{ "summary":"Batch Create Portfolios", "description":"Payload to create one or more portfolios using the workspace IDs, portfolio names, years planned in years, years planned in quarters, years planned in months, and descriptions.", "value":[ { "name":"IT Portfolio", "workspaceId":1525101, "description":"IT Projects List", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2 }, { "name":"Manufacturing Portfolio", "workspaceId":1525101, "description":"Manufacturing Projects List", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2 } ], "valueSetFlag":true }, "Batch_Create_Portfolios_that_include_Configured_Field_Text":{ "summary":"Batch Create Portfolios that include Configured Field Text", "description":"Payload to create one or more portfolios using the workspace IDs, portfolio names, years planned in years, years planned in quarters, years planned in months, descriptions, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "name":"IT Portfolio", "workspaceId":1525101, "description":"IT Projects List", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "name":"Manufacturing Portfolio", "workspaceId":1525101, "description":"Manufacturing Projects List", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio notes" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true }, "Batch_Create_Portfolios_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Portfolios by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create portfolios using the workspace code, portfolio name, years planned in year, years planned in quarter, years planned in month, and codeValuesPortfolio fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "codeValuesPortfolio":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, { "name":"IT Portfolio", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "codeValuesPortfolio":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the capital portfolio service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolio", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-batch-post", "x-filename-id":"portfolio-batch-post" }, "delete":{ "tags":[ "Portfolio" ], "summary":"Batch Delete Portfolios", "description":"Send a request to this endpoint to delete one or more portfolios. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/portfolio/batch_deleteBatch_12", "requestBody":{ "description":"The unique identifier of a portfolio.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the capital portfolio service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"portfolio-batch-delete", "x-filename-id":"portfolio-batch-delete" } }, "/portfolio/{capitalPortfolioId}":{ "delete":{ "tags":[ "Portfolio" ], "summary":"Delete a Portfolio ", "description":"Send a request to this endpoint to delete a portfolio. The application object with an ID value that matches the value of the {capitalPortfolioId} path parameter will be deleted.", "operationId":"/portfolio/{capitalPortfolioId}_delete_12", "parameters":[ { "name":"capitalPortfolioId", "in":"path", "description":"The unique identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the capital portfolio service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"portfolio-{capitalPortfolioId}-delete", "x-filename-id":"portfolio-capitalportfolioid-delete" } }, "/portfolio/{portfolioId}":{ "get":{ "tags":[ "Portfolio" ], "summary":"View a Portfolio", "description":"This endpoint returns portfolios that meet the following requirements:
  • The object is associated with a portfolio with an ID value that matches the value of the {portfolioId} path parameter.
Portfolios are collections of projects or other portfolios that enable you to plan resource and budget allocations across the collection.", "operationId":"/portfolio/{portfolioId}_find_12", "parameters":[ { "name":"portfolioId", "in":"path", "description":"The unique identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolio", "$ref":"#/components/schemas/ApiEntityPortfolio", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-{portfolioId}-get", "x-filename-id":"portfolio-portfolioid-get" } }, "/portfolio/name/{name}":{ "get":{ "tags":[ "Portfolio" ], "summary":"View all Portfolios by Name", "description":"This endpoint returns portfolios that meet the following requirements:
  • The object has a name that matches the value of the {name} path parameter.
Portfolios are collections of projects or other portfolios that enable you to plan resource and budget allocations across the collection.", "operationId":"/portfolio/name/{name}_findByCode_4", "parameters":[ { "name":"name", "in":"path", "description":"The name of a portfolio.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested portfolio does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolio", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-name-{name}-get", "x-filename-id":"portfolio-name-name-get" } }, "/portfolio/workspaceId/{workspaceId}/name/{name}":{ "get":{ "tags":[ "Portfolio" ], "summary":"View a Portfolio by Name and Workspace ", "description":"This endpoint returns portfolios that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
  • The object has a name that matches the value of the {name} path parameter.
Portfolios are collections of projects or other portfolios that enable you to plan resource and budget allocations across the collection.", "operationId":"/portfolio/workspaceId/{workspaceId}/name/{name}_findByCodeAndWorkspace_1", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The unique identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"name", "in":"path", "description":"The name of a portfolio.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested portfolio does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolio", "$ref":"#/components/schemas/ApiEntityPortfolio", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-workspaceId-{workspaceId}-name-{name}-get", "x-filename-id":"portfolio-workspaceid-workspaceid-name-name-get" } }, "/portfolio/workspace/{workspaceId}":{ "get":{ "tags":[ "Portfolio" ], "summary":"View Portfolios by Workspace", "description":"This endpoint returns portfolios that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Portfolios are collections of projects or other portfolios that enable you to plan resource and budget allocations across the collection.", "operationId":"/portfolio/workspace/{workspaceId}_findByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The unique identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolio", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-workspace-{workspaceId}-get", "x-filename-id":"portfolio-workspace-workspaceid-get" } }, "/portfolio/image/{portfolioId}":{ "get":{ "tags":[ "Portfolio" ], "summary":"View a Portfolio Image", "description":"This endpoint returns portfolio images that meet the following requirements:
  • The object is associated with a portfolio with an ID value that matches the value of the {portfolioId} path parameter.
", "operationId":"/portfolio/image/{portfolioId}_findPortfolioImage", "parameters":[ { "name":"portfolioId", "in":"path", "description":"The system-generated identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioImage", "$ref":"#/components/schemas/ApiEntityPortfolioImage", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-image-{portfolioId}-get", "x-filename-id":"portfolio-image-portfolioid-get" } }, "/portfolio/permissionSets":{ "get":{ "tags":[ "Portfolio" ], "summary":"View Available Permission Sets for Portfolio", "description":"Send a request to this endpoint to view the available permission sets for the provided portfolio.", "operationId":"/portfolio/permissionSets_getPermissionSets", "parameters":[ { "name":"portfolioId", "in":"query", "description":"The unique identifier of a portfolio.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"name", "in":"query", "description":"The name of a portfolio.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Unable to refresh the requested portfolio." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPermissionSets", "$ref":"#/components/schemas/ApiEntityPermissionSets", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-permissionSets-get", "x-filename-id":"portfolio-permissionsets-get" } }, "/portfolio/refresh/{portfolioId}":{ "get":{ "tags":[ "Portfolio" ], "summary":"Refresh a Portfolio", "description":"Send a request to this endpoint to refresh a portfolio. Refresh portfolios to ensure their contents contain up to date data.", "operationId":"/portfolio/refresh/{portfolioId}_refreshPortfolio", "parameters":[ { "name":"portfolioId", "in":"path", "description":"The unique identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Unable to refresh the requested portfolio." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-refresh-{portfolioId}-get", "x-filename-id":"portfolio-refresh-portfolioid-get" } }, "/portfolio/removeUsers":{ "post":{ "tags":[ "Portfolio" ], "summary":"Remove Users Assigned to a Portfolio", "description":"Send a request to this endpoint to remove users from a portfolio.", "operationId":"/portfolio/removeUsers_removeUsers", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user removal sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"Remove user from input.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRemovePortfolioUserPermissions", "$ref":"#/components/schemas/ApiEntityRemovePortfolioUserPermissions", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the portfolio service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRemovePortfolioUserPermissionsResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-removeUsers-post", "x-filename-id":"portfolio-removeusers-post" } }, "/portfolio/syncBatch":{ "post":{ "tags":[ "Portfolio" ], "summary":"Batch Sync Portfolios", "description":"Send a request to this endpoint to create or update one or more portfolios.", "operationId":"/portfolio/syncBatch_syncBatch_12", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any portfolio sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more portfolio objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Portfolio_using_Name":{ "summary":"Create or Update a Portfolio using Name", "description":"Payload to create or update a portfolio using the portfolio name, workspace code and description, years planned in year, years planned in quarter, years planned in month.", "value":[ { "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "description":"Roadways Proposal 2023", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2 } ], "valueSetFlag":true }, "Create_or_Update_a_Portfolio_using_program_linking":{ "summary":"Create or Update a Portfolio using program linking", "description":"Payload to create or update a portfolio using the portfolio name, workspace code and description, years planned in year, years planned in quarter, years planned in month, description and program ID.", "value":[ { "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "description":"Roadways Proposal 2023", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "programs":[ { "programId":4001 } ] } ], "valueSetFlag":true }, "Create_or_Update_a_Portfolio_to_Assign_a_Configured_Field":{ "summary":"Create or Update a Portfolio to Assign a Configured Field", "description":"Payload to create or update a portfolio using the portfolio name, workspace code and description, years planned in year, years planned in quarter, years planned in month, and and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "name":"Roadways Proposal", "workspaceCode":"Ananth Constructions", "description":"Roadways Proposal 2023", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2, "configuredFields":[ { "columnLabel":"Notes", "textValue":"Portfolio notes" }, { "columnDefinationId":61045, "textValue":"N" } ] }, { "portfolioId":826404, "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio notes" }, { "columnDefinationId":60045, "numberValue":2 } ] } ], "valueSetFlag":true }, "Create_or_Update_Portfolios_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create or Update Portfolios by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update portfolios using the workspace code, portfolio name, portfolio ID, years planned in year, years planned in quarter, years planned in month, and codeValuesPortfolio fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesPortfolio":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "name":"IT Portfolio", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2 }, { "codeValuesPortfolio":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "portfolioId":244756 } ], "valueSetFlag":true }, "Create_or_Update_Portfolios_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create or Update Portfolios by Assigning Code Values Using Codes", "description":"Payload to create or update portfolios using the workspace code, portfolio name, portfolio ID, years planned in year, years planned in quarter, years planned in month, and codeValuesPortfolio fields such as code value code and code type code.", "value":[ { "codeValuesPortfolio":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ], "name":"IT Portfolio", "workspaceCode":"Ananth Constructions", "yearsPlannedInMonth":1, "yearsPlannedInQuarter":2, "yearsPlannedInYear":2 }, { "codeValuesPortfolio":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "portfolioId":244756 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolio-syncBatch-post", "x-filename-id":"portfolio-syncbatch-post" } }, "/capitalPortfolioMember":{ "post":{ "tags":[ "Capital Portfolio Member" ], "summary":"Create a Capital Portfolio Member", "description":"Send a request to this endpoint to create a capital portfolio member. An application object will be created using the JSON data provided in the request body.", "operationId":"/capitalPortfolioMember_create_13", "requestBody":{ "description":"A capital portfolio member object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCapitalPortfolioMemberInput", "$ref":"#/components/schemas/ApiEntityCapitalPortfolioMemberInput", "exampleSetFlag":false }, "examples":{ "Create_a_Capital_Portfolio_Member_Using_Codes":{ "summary":"Create a Capital Portfolio Member Using Codes", "description":"Payload to create a capital portfolio member using the member portfolio code, member portfolio workspace code, capital portfolio code, and capital portfolio workspace code.", "value":{ "memberPortfolioName":"Roadways Proposal", "memberPortfolioWorkspaceCode":"Ananth Constructions", "capitalPortfolioName":"Energy Projects", "workspaceCode":"Ananth Constructions" }, "valueSetFlag":true }, "Create_a_Capital_Portfolio_Member":{ "summary":"Create a Capital Portfolio Member", "description":"Payload to create a capital portfolio member using the member portfolio ID and capital portfolio ID.", "value":{ "capitalPortfolioId":826401, "memberPortfolioId":826402 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the capital portfolio member service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCapitalPortfolioMember", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"capitalPortfolioMember-post", "x-filename-id":"capitalportfoliomember-post" } }, "/capitalPortfolioMember/batch":{ "post":{ "tags":[ "Capital Portfolio Member" ], "summary":"Batch Create Capital Portfolio Members", "description":"Send a request to this endpoint to create one or more capital portfolio members. An application object will be created for each JSON object provided in the request body.", "operationId":"/capitalPortfolioMember/batch_createBatch_13", "requestBody":{ "description":"One or more capital portfolio member objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCapitalPortfolioMemberInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Capital_Portfolio_Members":{ "summary":"Batch Create Capital Portfolio Members", "description":"Payload to create one or more capital portfolio members using the member portfolio IDs and capital portfolio IDs.", "value":[ { "capitalPortfolioId":826403, "memberPortfolioId":826404 }, { "capitalPortfolioId":826404, "memberPortfolioId":826403 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the capital portfolio member service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCapitalPortfolioMember", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"capitalPortfolioMember-batch-post", "x-filename-id":"capitalportfoliomember-batch-post" } }, "/capitalPortfolioMember/{capitalPortfolioMemberId}":{ "get":{ "tags":[ "Capital Portfolio Member" ], "summary":"View a Capital Portfolio Member", "description":"This endpoint returns capital portfolio member that meet the following requirements:
  • The object has an ID that matches the value of the {capitalPortfolioMemberId} path parameter.
Capital portfolio members are references to projects or portfolios contained in a capital portfolio.", "operationId":"/capitalPortfolioMember/{capitalPortfolioMemberId}_find_13", "parameters":[ { "name":"capitalPortfolioMemberId", "in":"path", "description":"The system-generated identifier of a capital portfolio member.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested capital portfolio member does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCapitalPortfolioMember", "$ref":"#/components/schemas/ApiEntityCapitalPortfolioMember", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"capitalPortfolioMember-{capitalPortfolioMemberId}-get", "x-filename-id":"capitalportfoliomember-capitalportfoliomemberid-get" } }, "/capitalPortfolioMember/portfolio/{capitalPortfolioId}":{ "get":{ "tags":[ "Capital Portfolio Member" ], "summary":"View all Capital Portfolio Members by Portfolio ID", "description":"This endpoint returns capital portfolio member that meet the following requirements:
  • The object is associated with a portfolio with an ID value that matches the value of the {capitalPortfolioId} path parameter.
Capital portfolio members are references to projects or portfolios contained in a capital portfolio.", "operationId":"/capitalPortfolioMember/portfolio/{capitalPortfolioId}_findByPortfolio", "parameters":[ { "name":"capitalPortfolioId", "in":"path", "description":"The system-generated identifier of a capital portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested capital portfolio member does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCapitalPortfolioMember", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"capitalPortfolioMember-portfolio-{capitalPortfolioId}-get", "x-filename-id":"capitalportfoliomember-portfolio-capitalportfolioid-get" } }, "/capitalPortfolioMember/parentCode":{ "get":{ "tags":[ "Capital Portfolio Member" ], "summary":"View all Capital Portfolio Members by Parent", "description":"Send a request to this endpoint to view all capital portfolio members under parent with codes matching the code fields in query parameters.", "operationId":"/capitalPortfolioMember/parentCode_getAllCapitalPortfolioMemberByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"capitalPortfolioName", "in":"query", "description":"The name of a capital portfolio.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested capital portfolio member does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCapitalPortfolioMember", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"capitalPortfolioMember-parentCode-get", "x-filename-id":"capitalportfoliomember-parentcode-get" } }, "/changeRequest":{ "put":{ "tags":[ "Change Request" ], "summary":"Update a Change Request ", "description":"Send a request to this endpoint to update a change request. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/changeRequest_update_12", "requestBody":{ "description":"A change request object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityChangeRequestInput", "$ref":"#/components/schemas/ApiEntityChangeRequestInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Change Request service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"changeRequest-put", "x-filename-id":"changerequest-put" }, "post":{ "tags":[ "Change Request" ], "summary":"Create a Change Request", "description":"Send a request to this endpoint to create a change request. An application object will be created using the JSON data provided in the request body.", "operationId":"/changeRequest_create_14", "requestBody":{ "description":"A change request object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityChangeRequestInput", "$ref":"#/components/schemas/ApiEntityChangeRequestInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Change Request service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityChangeRequest", "$ref":"#/components/schemas/ApiEntityChangeRequest", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"changeRequest-post", "x-filename-id":"changerequest-post" } }, "/changeRequest/batch":{ "put":{ "tags":[ "Change Request" ], "summary":"Batch Update Change Requests", "description":"Send a request to this endpoint to update one or more change requests. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/changeRequest/batch_updateBatch_12", "requestBody":{ "description":"One or more change request objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityChangeRequestInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Change Request service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"changeRequest-batch-put", "x-filename-id":"changerequest-batch-put" }, "post":{ "tags":[ "Change Request" ], "summary":"Batch Create Change Requests", "description":"Send a request to this endpoint to create one or more change requests. An application object will be created for each JSON object provided in the request body.", "operationId":"/changeRequest/batch_createBatch_14", "requestBody":{ "description":"One or more change request objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityChangeRequestInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Change Request service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityChangeRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"changeRequest-batch-post", "x-filename-id":"changerequest-batch-post" }, "delete":{ "tags":[ "Change Request" ], "summary":"Batch Delete Change Requests", "description":"Send a request to this endpoint to delete one or more change requests. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/changeRequest/batch_deleteBatch_13", "requestBody":{ "description":"One or more system-generated identifiers of a change request.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Change Request service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"changeRequest-batch-delete", "x-filename-id":"changerequest-batch-delete" } }, "/changeRequest/{changeRequestId}":{ "get":{ "tags":[ "Change Request" ], "summary":"View a Change Request ", "description":"This endpoint returns change requests that meet the following requirements:
  • The object has an ID that matches the value of the {changeRequestId} path parameter.
", "operationId":"/changeRequest/{changeRequestId}_find_14", "parameters":[ { "name":"changeRequestId", "in":"path", "description":"The system-generated identifier of a change request.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested change request does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityChangeRequest", "$ref":"#/components/schemas/ApiEntityChangeRequest", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"changeRequest-{changeRequestId}-get", "x-filename-id":"changerequest-changerequestid-get" }, "delete":{ "tags":[ "Change Request" ], "summary":"Delete a Change Request ", "description":"Send a request to this endpoint to delete a change request. The application object with an ID value that matches the value of the {changeRequestId} path parameter will be deleted.", "operationId":"/changeRequest/{changeRequestId}_delete_13", "parameters":[ { "name":"changeRequestId", "in":"path", "description":"The system-generated identifier of a change request.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Change Request service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"changeRequest-{changeRequestId}-delete", "x-filename-id":"changerequest-changerequestid-delete" } }, "/changeRequest/parentCode":{ "get":{ "tags":[ "Change Request" ], "summary":"View All Change Requests by Parent", "description":"Send a request to this endpoint to view all change requests under parent with codes matching the code fields in query parameters.", "operationId":"/changeRequest/parentCode_getAllChangeRequestsByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityChangeRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"changeRequest-parentCode-get", "x-filename-id":"changerequest-parentcode-get" } }, "/changeRequest/itemCode":{ "get":{ "tags":[ "Change Request" ], "summary":"View a Change Request by Code", "description":"Send a request to this endpoint to view a change request with codes matching the code fields in query parameters.", "operationId":"/changeRequest/itemCode_getChangeRequestByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"changeRequestCode", "in":"query", "description":"The user-specified identifier of a change request.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityChangeRequest", "$ref":"#/components/schemas/ApiEntityChangeRequest", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"changeRequest-itemCode-get", "x-filename-id":"changerequest-itemcode-get" } }, "/changeRequest/syncBatch":{ "post":{ "tags":[ "Change Request" ], "summary":"Batch Sync Change Requests ", "description":"Send a request to this endpoint to create or update one or more change requests.", "operationId":"/changeRequest/syncBatch_syncBatch_13", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any change request record sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more change request objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityChangeRequestInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"changeRequest-syncBatch-post", "x-filename-id":"changerequest-syncbatch-post" } }, "/codeType":{ "get":{ "tags":[ "Code Type" ], "summary":"View Code Types by Associated Object ", "description":"This endpoint returns code types that meet the following requirements:
  • The object is associated with one or more object types that match the value of the {type} query parameter.
", "operationId":"/codeType_getCodeTypesByCodeEntityType", "parameters":[ { "name":"type", "in":"query", "description":"Code EntityType to get Code Types
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "COMMITMENT", "CONSTRAINT", "CONTRACT", "CUSTOM_LOG_ITEM", "FUND", "IDEA", "PBS", "PORTFOLIO", "PROGRAM", "PROJECT", "REPORT", "RESOURCE", "RFI", "RISK", "SCOPE_ASSIGNMENT", "SCOPE_ITEM", "STRATEGY", "SUBMITTAL", "TASKS", "WBS", "WORK_PACKAGE" ] } } ], "responses":{ "404":{ "description":"The requested code type does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-get", "x-filename-id":"codetype-get" }, "put":{ "tags":[ "Code Type" ], "summary":"Update a Code Type ", "description":"Send a request to this endpoint to update a code type. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/codeType_update_13", "requestBody":{ "description":"The Code Type to be updated", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCodeTypeInput", "$ref":"#/components/schemas/ApiEntityCodeTypeInput", "exampleSetFlag":false }, "examples":{ "Update_a_Code_Type_Using_Code_Type_ID":{ "summary":"Update a Code Type Using Code Type ID", "description":"Payload to update name of a code type using code type ID.", "value":{ "codeTypeId":10001, "codeTypeName":"Risk Manager" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"codeType-put", "x-filename-id":"codetype-put" }, "post":{ "tags":[ "Code Type" ], "summary":"Create a Code Type", "description":"Send a request to this endpoint to create a code type. An application object will be created using the JSON data provided in the request body.", "operationId":"/codeType_create_15", "requestBody":{ "description":"The Code Type to be created", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCodeTypeInput", "$ref":"#/components/schemas/ApiEntityCodeTypeInput", "exampleSetFlag":false }, "examples":{ "Create_a_Code_Type":{ "summary":"Create a Code Type", "description":"Payload to create a code type using workspace ID, code type code, and code type name.", "value":{ "codeTypeCode":"Risk Manager", "codeTypeName":"Risk Manager", "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCodeType", "$ref":"#/components/schemas/ApiEntityCodeType", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-post", "x-filename-id":"codetype-post" } }, "/codeType/batch":{ "put":{ "tags":[ "Code Type" ], "summary":"Batch Update Code Types", "description":"Send a request to this endpoint to update one or more code types. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/codeType/batch_updateBatch_13", "requestBody":{ "description":"The Code Types to be updated", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Code_Types_Using_Code_Type_IDs":{ "summary":"Batch Update Code Types Using Code Type IDs", "description":"Payload to update name of one or more code types using code type IDs.", "value":[ { "codeTypeId":10001, "codeTypeName":"Risk Manager" }, { "codeTypeId":10001, "codeTypeName":"Owner" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"codeType-batch-put", "x-filename-id":"codetype-batch-put" }, "post":{ "tags":[ "Code Type" ], "summary":"Batch Create Code Types", "description":"Send a request to this endpoint to create one or more code types. An application object will be created for each JSON object provided in the request body.", "operationId":"/codeType/batch_createBatch_15", "requestBody":{ "description":"One or more code type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Code_Types":{ "summary":"Batch Create Code Types", "description":"Payload to batch create code types using workspace ID, code type code, and code type name.", "value":[ { "codeTypeCode":"Risk Manager", "codeTypeName":"Risk Manager", "workspaceId":10001 }, { "codeTypeCode":"Owner", "codeTypeName":"Owner", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-batch-post", "x-filename-id":"codetype-batch-post" }, "delete":{ "tags":[ "Code Type" ], "summary":"Batch Delete Code Types", "description":"Send a request to this endpoint to delete one or more code types. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/codeType/batch_deleteBatch_14", "requestBody":{ "description":"IDs of the Code Types to be deleted", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"codeType-batch-delete", "x-filename-id":"codetype-batch-delete" } }, "/codeType/{codeTypeId}":{ "get":{ "tags":[ "Code Type" ], "summary":"View a Code Type", "description":"This endpoint returns code types that meet the following requirements:
  • The object is associated with a code type with an ID value that matches the value of the {codeTypeId} path parameter.
", "operationId":"/codeType/{codeTypeId}_find_15", "parameters":[ { "name":"codeTypeId", "in":"path", "description":"ID of the Code Type to be loaded.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested code type does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCodeType", "$ref":"#/components/schemas/ApiEntityCodeType", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-{codeTypeId}-get", "x-filename-id":"codetype-codetypeid-get" }, "delete":{ "tags":[ "Code Type" ], "summary":"Delete a Code Type ", "description":"Send a request to this endpoint to delete a code type. The application object with an ID value that matches the value of the {codeTypeId} path parameter will be deleted.", "operationId":"/codeType/{codeTypeId}_delete_14", "parameters":[ { "name":"codeTypeId", "in":"path", "description":"ID of the Code Type to be deleted", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"codeType-{codeTypeId}-delete", "x-filename-id":"codetype-codetypeid-delete" } }, "/codeType/{codeTypeId}/assignments":{ "delete":{ "tags":[ "Code Type" ], "summary":"Delete Code Type Assignments", "description":"Send a request to this endpoint to delete code type assignments. The assignments provided in the body will be deleted from the code type object with an ID value that matches the value of the {codeTypeId} path parameter.", "operationId":"/codeType/{codeTypeId}/assignments_deleteAssignments", "parameters":[ { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"List of entity types assigned to the code type.
Allowed Values: [ \"ACTIVITY\", \"CONSTRAINT\", \"CUSTOM_LOG_ITEM\", \"DOCUMENT\", \"FUND\", \"IDEA\", \"PBS\", \"PORTFOLIO\", \"PROGRAM\", \"PROJECT\", \"REPORT\", \"RESOURCE\", \"RISK\", \"SCOPE_ASSIGNMENT\", \"SCOPE_ITEM\", \"STRATEGY\", \"TASKS\", \"WBS\", \"WORK_PACKAGE\" ]", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"codeType-{codeTypeId}-assignments-delete", "x-filename-id":"codetype-codetypeid-assignments-delete" } }, "/codeType/byParent":{ "get":{ "tags":[ "Code Type" ], "summary":"View Code Types by Workspace Code", "description":"Send a request to this endpoint to view all code types under a workspace with code matching the code field in query parameters.", "operationId":"/codeType/byParent_getAllCodeTypeByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"workspace code under which all the code types have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-byParent-get", "x-filename-id":"codetype-byparent-get" } }, "/codeType/byItemCode":{ "get":{ "tags":[ "Code Type" ], "summary":"View a Code Type by Code", "description":"Send a request to this endpoint to view a code type with codes matching the code fields in query parameters.", "operationId":"/codeType/byItemCode_getCodeTypeByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"workspace code of the code type to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"codeTypeCode", "in":"query", "description":"The user specified Identifier of the code type to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCodeType", "$ref":"#/components/schemas/ApiEntityCodeType", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-byItemCode-get", "x-filename-id":"codetype-byitemcode-get" } }, "/codeType/project":{ "get":{ "tags":[ "Code Type" ], "summary":"View Code Types by Project and Workspace", "description":"Send a request to this endpoint to view all code types under a project with codes matching the code fields in query parameters.", "operationId":"/codeType/project_getCodeTypeByProjectAndWorkspaceCode", "parameters":[ { "name":"projectCode", "in":"query", "description":"Project code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"workspace code of the code type to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The provided Workspace or Project does not exist or has been deleted." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-project-get", "x-filename-id":"codetype-project-get" } }, "/codeType/project/{projectId}":{ "get":{ "tags":[ "Code Type" ], "summary":"View Code Types by Project", "description":"This endpoint returns code types that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/codeType/project/{projectId}_getCodeTypesByProjectId", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Project does not exist or has been deleted." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-project-{projectId}-get", "x-filename-id":"codetype-project-projectid-get" } }, "/codeType/workspace/{workspaceId}":{ "get":{ "tags":[ "Code Type" ], "summary":"View Code Types by Workspace ", "description":"This endpoint returns code types that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspace} path parameter.
", "operationId":"/codeType/workspace/{workspaceId}_getCodeTypesByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested code type does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-workspace-{workspaceId}-get", "x-filename-id":"codetype-workspace-workspaceid-get" } }, "/codeType/promote":{ "put":{ "tags":[ "Code Type" ], "summary":"Promote Project Code Types To Workspace", "description":"Send a request to this endpoint to promote the project code types provided in the payload to their immediate workspaces.", "operationId":"/codeType/promote_promoteProjectCalendars_1", "requestBody":{ "description":"The Project CodeType to be promoted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPromoteProjectCodeType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"codeType-promote-put", "x-filename-id":"codetype-promote-put" } }, "/codeType/syncBatch":{ "post":{ "tags":[ "Code Type" ], "summary":"Batch Sync Code Types", "description":"Send a request to this endpoint to create or update one or more code types.", "operationId":"/codeType/syncBatch_syncBatch_14", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any code type sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more code type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Code_Type_for_a_Project":{ "summary":"Create or Update a Code Type for a Project", "description":"Payload to create or update a code type using the workspace ID, project ID, code type code, and code type name.", "value":[ { "codeTypeCode":"Risk Manager", "codeTypeName":"Risk Manager", "workspaceId":10001, "projectId":22101 } ], "valueSetFlag":true }, "Create_or_Update_a_Code_Type_for_a_Workspace":{ "summary":"Create or Update a Code Type for a Workspace", "description":"Payload to create or update a code type using the workspace ID, code type code, and code type name.", "value":[ { "codeTypeCode":"Risk Manager", "codeTypeName":"Risk Manager", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeType-syncBatch-post", "x-filename-id":"codetype-syncbatch-post" } }, "/codeValue":{ "put":{ "tags":[ "Code Value" ], "summary":"Update a Code Value ", "description":"Send a request to this endpoint to update a code value. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/codeValue_update_14", "requestBody":{ "description":"The Code Value to be updated", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCodeValueInput", "$ref":"#/components/schemas/ApiEntityCodeValueInput", "exampleSetFlag":false }, "examples":{ "Update_a_Code_Value_Using_Code_Value_ID":{ "summary":"Update a Code Value Using Code Value ID", "description":"Payload to update name of a code type using code type ID.", "value":{ "codeValueId":10001, "codeValueName":"High Value" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Value service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"codeValue-put", "x-filename-id":"codevalue-put" }, "post":{ "tags":[ "Code Value" ], "summary":"Create a Code Value", "description":"Send a request to this endpoint to create a code value. An application object will be created using the JSON data provided in the request body.", "operationId":"/codeValue_create_16", "requestBody":{ "description":"The Code Value to be created", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCodeValueInput", "$ref":"#/components/schemas/ApiEntityCodeValueInput", "exampleSetFlag":false }, "examples":{ "Create_a_Code_Value_Using_Parent_Code_Value_Codes":{ "summary":"Create a Code Value Using Parent Code Value Codes", "description":"Payload to create a code value using code type ID, code value code, code value name, and parent code value codes (parentCVCodes) which is a list of parent code value codes in a hierarchical order.", "value":{ "codeValueCode":"Medium", "codeValueName":"Medium", "codeTypeId":"1489201", "parentCVCodes":[ "Critical", "High" ] }, "valueSetFlag":true }, "Create_a_Code_Value_Using_Parent_ID":{ "summary":"Create a Code Value Using Parent ID", "description":"Payload to create a code value using code type ID, code value code, code value name, and parent ID.", "value":{ "codeValueCode":"High", "codeValueName":"High", "codeTypeId":"1489201", "parentId":1789501 }, "valueSetFlag":true }, "Create_a_Code_Value":{ "summary":"Create a Code Value", "description":"Payload to create a code value using code type ID, code value code, and code value name.", "value":{ "codeValueCode":"High", "codeValueName":"High", "codeTypeId":1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Value service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCodeValue", "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-post", "x-filename-id":"codevalue-post" } }, "/codeValue/batch":{ "put":{ "tags":[ "Code Value" ], "summary":"Batch Update Code Values ", "description":"Send a request to this endpoint to update one or more code values. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/codeValue/batch_updateBatch_14", "requestBody":{ "description":"The Code Value to be updated", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Code_Values_Using_Code_Value_IDs":{ "summary":"Batch Update Code Values Using Code Value IDs", "description":"Payload to update name of one or more code values using code value IDs.", "value":[ { "codeValueId":10001, "codeValueName":"High Value" }, { "codeValueId":10002, "codeValueName":"Low Value" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Value service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"codeValue-batch-put", "x-filename-id":"codevalue-batch-put" }, "post":{ "tags":[ "Code Value" ], "summary":"Batch Create Code Values", "description":"Send a request to this endpoint to create one or more code values. An application object will be created for each JSON object provided in the request body.", "operationId":"/codeValue/batch_createBatch_16", "requestBody":{ "description":"The Code Values to be created", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Code_Values":{ "summary":"Batch Create Code Values", "description":"Payload to create one or more code values using code type ID, code value code, and code value name.", "value":[ { "codeValueCode":"High", "codeValueName":"High", "codeTypeId":1 }, { "codeValueCode":"Low", "codeValueName":"Low", "codeTypeId":1 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Value service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-batch-post", "x-filename-id":"codevalue-batch-post" }, "delete":{ "tags":[ "Code Value" ], "summary":"Batch Delete Code Values ", "description":"Send a request to this endpoint to delete one or more code values. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/codeValue/batch_deleteBatch_15", "requestBody":{ "description":"IDs of the Code Values to be deleted", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Value service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"codeValue-batch-delete", "x-filename-id":"codevalue-batch-delete" } }, "/codeValue/{codeValueId}":{ "get":{ "tags":[ "Code Value" ], "summary":"View a Code Value ", "description":"This endpoint returns code values that meet the following requirements:
  • The object has an ID that matches the value of the {codeValueId} path parameter.
", "operationId":"/codeValue/{codeValueId}_find_16", "parameters":[ { "name":"codeValueId", "in":"path", "description":"ID of the Code Value to be loaded.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested code value does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCodeValue", "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-{codeValueId}-get", "x-filename-id":"codevalue-codevalueid-get" }, "delete":{ "tags":[ "Code Value" ], "summary":"Delete a Code Value", "description":"Send a request to this endpoint to delete a code value. The application object with an ID value that matches the value of the {codeValueId} path parameter will be deleted.", "operationId":"/codeValue/{codeValueId}_delete_15", "parameters":[ { "name":"codeValueId", "in":"path", "description":"ID of the Code Value to be deleted", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Code Value service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"codeValue-{codeValueId}-delete", "x-filename-id":"codevalue-codevalueid-delete" } }, "/codeValue/objectType/{codeValueObjectType}":{ "delete":{ "tags":[ "Code Value" ], "summary":"Delete Code Value Assignments from an Object", "description":"Send a request to this endpoint to delete one or more code value assignments from a given object. The object ID from which the code value assignments needs to be deleted should be given as a path parameter and the assignment IDs should be given as a body parameter. For example, an array of projectCodeValueId(s) should be given in the body with projectId in path for project object.", "operationId":"/codeValue/objectType/{codeValueObjectType}_deleteCodeValueAssignments", "parameters":[ { "name":"codeValueObjectType", "in":"path", "description":"The name of an object from which the code value assignments needs to be deleted.
Allowed Values: [ \"SCOPE_ITEM\", \"PROJECT\", \"SCOPE_ASSIGNMENT\", \"WBS\", \"WORK_PACKAGE\", \"ACTIVITY\", \"RESOURCE\", \"CONTRACT\", \"RISK\", \"COMMITMENT\", \"TASKS\", \"STRATEGY\", \"FUND\", \"SUBMITTAL\", \"IDEA\", \"RFI\", \"CUSTOM_LOG_ITEM\" ]", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "CONTRACT", "RISK", "COMMITMENT", "TASKS", "CONSTRAINT", "STRATEGY", "FUND", "SUBMITTAL", "IDEA", "RFI", "CUSTOM_LOG_ITEM", "PORTFOLIO", "DOCUMENT" ] } } ], "requestBody":{ "description":"IDs of the Code Value Assignments to be deleted", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Value service." }, "404":{ "description":"The path parameter is not present in the list of allowable values." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"codeValue-objectType-{codeValueObjectType}-delete", "x-filename-id":"codevalue-objecttype-codevalueobjecttype-delete" } }, "/codeValue/codeType/{codeTypeId}":{ "get":{ "tags":[ "Code Value" ], "summary":"View Code Values by Code Type ", "description":"This endpoint returns code values that meet the following requirements:
  • The object is associated with a code type with an ID value that matches the value of the {codeTypeId} path parameter.
", "operationId":"/codeValue/codeType/{codeTypeId}_findCodeValueByType", "parameters":[ { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested code value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-codeType-{codeTypeId}-get", "x-filename-id":"codevalue-codetype-codetypeid-get" } }, "/codeValue/code/{codeValueCode}/codeType/{codeTypeId}":{ "get":{ "tags":[ "Code Value" ], "summary":"View Code Values by Code Type and Code", "description":"This endpoint returns code values that meet the following requirements:
  • The object has a code that matches the value of the {codeValueCode} path parameter.
  • The object is associated with a code type with an ID value that matches the value of the {codeTypeId} path parameter.
", "operationId":"/codeValue/code/{codeValueCode}/codeType/{codeTypeId}_findCodeValueByTypeId", "parameters":[ { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested code value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-code-{codeValueCode}-codeType-{codeTypeId}-get", "x-filename-id":"codevalue-code-codevaluecode-codetype-codetypeid-get" } }, "/codeValue/codeType/name/{codeTypeName}":{ "get":{ "tags":[ "Code Value" ], "summary":"View Code Values by Code Type Name", "description":"This endpoint returns code values that meet the following requirements:
  • The object is associated with a code type with a name value that matches the value of the {codeTypeName} path parameter.
", "operationId":"/codeValue/codeType/name/{codeTypeName}_findCodeValueByTypeName", "parameters":[ { "name":"codeTypeName", "in":"path", "description":"The name of a code type.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested code value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-codeType-name-{codeTypeName}-get", "x-filename-id":"codevalue-codetype-name-codetypename-get" } }, "/codeValue/projectCodeTypes":{ "get":{ "tags":[ "Code Value" ], "summary":"View Code Values by Project, Workspace and CodeType", "description":"Send a request to this endpoint to view all code values under a code type with codes matching the code fields in query parameters.", "operationId":"/codeValue/projectCodeTypes_getAllCodeValueByAllParentCodes", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"codeTypeCode", "in":"query", "description":"The user-specified identifier of a code type.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The provided Workspace or Project or Code Type does not exist or has been deleted." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-projectCodeTypes-get", "x-filename-id":"codevalue-projectcodetypes-get" } }, "/codeValue/byParent":{ "get":{ "tags":[ "Code Value" ], "summary":"View All Code Values by Parent", "description":"Send a request to this endpoint to view all code values under parent with codes matching the code fields in query parameters.", "operationId":"/codeValue/byParent_getAllCodeValueByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"codeTypeCode", "in":"query", "description":"The user-specified identifier of a code type.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-byParent-get", "x-filename-id":"codevalue-byparent-get" } }, "/codeValue/{codeValueId}/childrenHierarchy":{ "get":{ "tags":[ "Code Value" ], "summary":"View All Child Code Values in a Code Value Hierarchy ", "description":"This endpoint returns all children in code value hierarchies that meet the following requirements:
  • The object has an ID that matches the value of the {codeValueId} path parameter.
", "operationId":"/codeValue/{codeValueId}/childrenHierarchy_getChildrenHierarchy", "parameters":[ { "name":"codeValueId", "in":"path", "description":"The system-generated identifier of a code value.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested code value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-{codeValueId}-childrenHierarchy-get", "x-filename-id":"codevalue-codevalueid-childrenhierarchy-get" } }, "/codeValue/byItemCode":{ "get":{ "tags":[ "Code Value" ], "summary":"View All Code Values by Code", "description":"Send a request to this endpoint to view all code values with codes matching the code fields in query parameters.", "operationId":"/codeValue/byItemCode_getCodeValueByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"codeTypeCode", "in":"query", "description":"The user-specified identifier of a code type.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"codeValueCode", "in":"query", "description":"The user-specified identifier of a code value.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-byItemCode-get", "x-filename-id":"codevalue-byitemcode-get" } }, "/codeValue/syncBatch":{ "post":{ "tags":[ "Code Value" ], "summary":"Batch Sync Code Values", "description":"Send a request to this endpoint to create or update one or more code values.", "operationId":"/codeValue/syncBatch_syncBatch_15", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any code value sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more code value objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Code_Value_using_Code":{ "summary":"Create or Update a Code Value using Code", "description":"Payload to create or update a code value using the code type ID, code value code, and code value name.", "value":[ { "codeValueCode":"Critical", "codeValueName":"Critical", "codeTypeId":1 } ], "valueSetFlag":true }, "Create_or_Update_a_Code_Value_Using_Parent_Code_Value_Codes":{ "summary":"Create or Update a Code Value Using Parent Code Value Codes", "description":"Payload to create or update a code value using code type ID, code value code, code value name, and parent code value codes (parentCVCodes) which is a list of parent code value codes in a hierarchical order.", "value":[ { "codeValueCode":"Medium", "codeValueName":"Medium", "codeTypeId":"1489201", "parentCVCodes":[ "Critical", "High" ] }, { "codeValueCode":"Level3", "codeValueName":"Level3", "codeTypeId":"1489202", "parentCVCodes":[ "Level1", "Level2" ] } ], "valueSetFlag":true }, "Create_or_Update_a_Code_Value_Using_Parent_ID":{ "summary":"Create or Update a Code Value Using Parent ID", "description":"Payload to create or update a code value using code type ID, code value code, code value name, and parent ID.", "value":[ { "codeValueCode":"High", "codeValueName":"High", "codeTypeId":"1489201", "parentId":1789501 }, { "codeValueCode":"Area", "codeValueName":"Area", "codeTypeId":"1489202", "parentId":1789501 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Code Value service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"codeValue-syncBatch-post", "x-filename-id":"codevalue-syncbatch-post" } }, "/company/{companyId}":{ "get":{ "tags":[ "Company" ], "summary":"View a Company", "description":"This endpoint returns companies that meet the following requirements:
  • The object is associated with a company with an ID value that matches the value of the {companyId} path parameter.
", "operationId":"/company/{companyId}_find_17", "parameters":[ { "name":"companyId", "in":"path", "description":"The system-generated identifier of a company.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested company does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCompany", "$ref":"#/components/schemas/ApiEntityCompany", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"company-{companyId}-get", "x-filename-id":"company-companyid-get" }, "delete":{ "tags":[ "Company" ], "summary":"Delete a Company", "description":"Send a request to this endpoint to delete a company. The application object with an ID value that matches the value of the {companyId} path parameter will be deleted.", "operationId":"/company/{companyId}_delete_16", "parameters":[ { "name":"companyId", "in":"path", "description":"The system-generated identifier of a company.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Company service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"company-{companyId}-delete", "x-filename-id":"company-companyid-delete" } }, "/company/list":{ "get":{ "tags":[ "Company" ], "summary":"View all Companies", "description":"This endpoint returns all companies.", "operationId":"/company/list_findAllCompanies", "responses":{ "404":{ "description":"The requested company does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompany", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"company-list-get", "x-filename-id":"company-list-get" } }, "/company/name/{companyName}":{ "get":{ "tags":[ "Company" ], "summary":"View a Company by Name", "description":"This endpoint returns companies that meet the following requirements:
  • The object has a name that matches the value of the {companyName} path parameter.
", "operationId":"/company/name/{companyName}_findByName_2", "parameters":[ { "name":"companyName", "in":"path", "description":"The name of a company.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested company does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompany", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"company-name-{companyName}-get", "x-filename-id":"company-name-companyname-get" } }, "/company/externallySourced":{ "get":{ "tags":[ "Company" ], "summary":"View Integrated Companies", "description":"This endpoint returns all integrated company objects.", "operationId":"/company/externallySourced_findForSource_2", "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedCompany", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"company-externallySourced-get", "x-filename-id":"company-externallysourced-get" } }, "/company/tenantOwner":{ "get":{ "tags":[ "Company" ], "summary":"View Companies by Tenant Owner", "description":"Send a request to this endpoint to view all companies under a tenant.", "operationId":"/company/tenantOwner_findTenantOwner", "responses":{ "404":{ "description":"Invalid input for the Company service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompany", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"company-tenantOwner-get", "x-filename-id":"company-tenantowner-get" } }, "/company/sync":{ "post":{ "tags":[ "Company" ], "summary":"Integrate a Company with an External Data Source", "description":"Send a request to this endpoint to create or update an integrated a company. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/company/sync_sync_2", "requestBody":{ "description":"The unique identifier of company data in an external source.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedCompanyInput", "$ref":"#/components/schemas/ApiEntityExternallySourcedCompanyInput", "exampleSetFlag":false }, "examples":{ "Integrate_a_Company_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Integrate a Company that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create or update a company using source ID, source site ID, company name, country name, country code, postal code, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "companyName":"Oracle Corporation", "countryCode":"US", "postalCode":"100001", "sourceId":1, "sourceSiteId":1, "configuredFields":[ { "columnName":"Notes", "textValue":"Company is registered" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Integrate_a_Company_Using_Source_ID":{ "summary":"Integrate a Company Using Source ID", "description":"Payload to create or update a company using source ID, source site ID, company name, country name, country code, and postal code.", "value":{ "companyName":"Oracle Corporation", "countryCode":"US", "postalCode":"100001", "sourceId":1, "sourceSiteId":1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"company-sync-post", "x-filename-id":"company-sync-post" } }, "/company/syncBatch":{ "post":{ "tags":[ "Company" ], "summary":"Batch Integrate Companies with an External Data Source", "description":"Send a request to this endpoint to create or update one or more integrated companies. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API. ", "operationId":"/company/syncBatch_syncBatch_16", "requestBody":{ "description":"The unique identifier of company data in an external source.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedCompanyInput", "type":"array", "$ref":"#/components/schemas/ApiEntityExternallySourcedCompanyInput", "exampleSetFlag":false }, "examples":{ "Batch_Integrate_Companies_Using_Source_IDs":{ "summary":"Batch Integrate Companies Using Source IDs", "description":"Payload to create or update one or more companies using source ID, source site ID, company name, country name, country code, and postal code.", "value":[ { "companyName":"Oracle Corporation - HQ", "countryCode":"US", "postalCode":"100001", "sourceId":1, "sourceSiteId":1 }, { "companyName":"Oracle Corporation - London", "countryCode":"OK", "postalCode":"100001", "sourceId":1, "sourceSiteId":1 } ], "valueSetFlag":true }, "Batch_Integrate_Companies_that_include_Configured_Field_Text":{ "summary":"Batch Integrate Companies that include Configured Field Text", "description":"Payload to create or update one or more companies using source ID, source site ID, company name, country name, country code, postal code, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "companyName":"Oracle Corporation - HQ", "countryCode":"US", "postalCode":"100001", "sourceId":1, "sourceSiteId":1, "configuredFields":[ { "columnName":"Notes", "textValue":"Company is registered" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "companyName":"Oracle Corporation - London", "countryCode":"OK", "postalCode":"100001", "sourceId":2, "sourceSiteId":2, "configuredFields":[ { "columnName":"Notes", "textValue":"Company is registered" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"company-syncBatch-post", "x-filename-id":"company-syncbatch-post" } }, "/configuredField":{ "put":{ "tags":[ "Configured Fields" ], "summary":"Update a Configured Field", "description":"Send a request to this endpoint to update a configured field.", "operationId":"/configuredField_update_15", "parameters":[ { "name":"inheritedWorkspaceId", "in":"query", "description":"Deprecated. As of 25.8.
The ID of the workspace where the configured field locale label change is needed.
This is not applicable for PROGRAM, IDEA, STRATEGY, and DOCUMENT object types.
This is an optional parameter. ", "deprecated":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"A configured field object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityColumnDefinitionInput", "$ref":"#/components/schemas/ApiEntityColumnDefinitionInput", "exampleSetFlag":false }, "examples":{ "Update_a_Configured_Fields_Using_Column_Definition_ID":{ "summary":"Update a Configured Fields Using Column Definition ID", "description":"Payload to update the label of a Project configured field using column definition ID.", "value":{ "columnDefinitionId":10001, "label":"User Satisfaction Value" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Configured Fields service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"configuredField-put", "x-filename-id":"configuredfield-put" }, "post":{ "tags":[ "Configured Fields" ], "summary":"Create a Configured Field", "description":"Send a request to this endpoint to create a configured field.", "operationId":"/configuredField_createUdf", "requestBody":{ "description":"A configured field object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityColumnDefinitionInput", "$ref":"#/components/schemas/ApiEntityColumnDefinitionInput", "exampleSetFlag":false }, "examples":{ "Create_a_Configured_Field":{ "summary":"Create a Configured Field", "description":"Payload to create a Project configured field using workspace ID, data type, label, view column name, physical type, and flex object.", "value":{ "dataType":"FT_TEXT", "label":"User Satisfaction", "viewColumnName":"User Satisfaction", "physicalType":"STRING", "flexObject":"PROJECT", "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Configured Fields service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityColumnDefinition", "$ref":"#/components/schemas/ApiEntityColumnDefinition", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"configuredField-post", "x-filename-id":"configuredfield-post" } }, "/configuredField/batch":{ "delete":{ "tags":[ "Configured Fields" ], "summary":"Batch Delete Configured Fields", "description":"Send a request to this endpoint to delete multiple configured fields.", "operationId":"/configuredField/batch_deleteBatch_16", "parameters":[ { "name":"objectType", "in":"query", "description":"This is a required field for PROGRAM, IDEA, STRATEGY and DOCUMENT object types and optional for other object types.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "DOCUMENT", "FUND", "IDEA", "PORTFOLIO", "PROGRAM", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "STRATEGY", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] } } ], "requestBody":{ "description":"One or more system-generated identifiers of configured fields.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Configured Fields service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"configuredField-batch-delete", "x-filename-id":"configuredfield-batch-delete" } }, "/configuredField/{columnDefinitionId}":{ "get":{ "tags":[ "Configured Fields" ], "summary":"View a Configured Field", "description":"This endpoint returns configured fields that meet the following requirements:
  • The object has an ID that matches the value of the {columnDefinitionId} path parameter.
", "operationId":"/configuredField/{columnDefinitionId}_find_18", "parameters":[ { "name":"columnDefinitionId", "in":"path", "description":"The system-generated identifier of a configured field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"objectType", "in":"query", "description":"This is a required field for PROGRAM, IDEA, STRATEGY and DOCUMENT object types and optional for other object types.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "DOCUMENT", "FUND", "IDEA", "PORTFOLIO", "PROGRAM", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "STRATEGY", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] } } ], "responses":{ "404":{ "description":"The requested configured field does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityColumnDefinition", "$ref":"#/components/schemas/ApiEntityColumnDefinition", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"configuredField-{columnDefinitionId}-get", "x-filename-id":"configuredfield-columndefinitionid-get" }, "delete":{ "tags":[ "Configured Fields" ], "summary":"Delete a Configured Field", "description":"Send a request to this endpoint to delete a configured field.", "operationId":"/configuredField/{columnDefinitionId}_deleteUdf", "parameters":[ { "name":"columnDefinitionId", "in":"path", "description":"The system-generated identifier of a configured field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"objectType", "in":"query", "description":"This is a required field for PROGRAM, IDEA, STRATEGY and DOCUMENT object types and optional for other object types.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "DOCUMENT", "FUND", "IDEA", "PORTFOLIO", "PROGRAM", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "STRATEGY", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] } } ], "responses":{ "400":{ "description":"Invalid input for the Configured Fields service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"configuredField-{columnDefinitionId}-delete", "x-filename-id":"configuredfield-columndefinitionid-delete" } }, "/configuredField/workspace/{workspaceId}":{ "get":{ "tags":[ "Configured Fields" ], "summary":"View all Configured Fields under a Workspace", "description":"This endpoint returns configured fields that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Document, Program, Idea and Strategy fields cannot be fetched from this URL, please use the respective provided URLs instead.", "operationId":"/configuredField/workspace/{workspaceId}_getColumnDefinitionsByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"hierarchy", "in":"query", "description":"The query flag to retrieve all owned and inherited configured fields(ex: hierarchy=true). ", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ] } } ], "responses":{ "404":{ "description":"The requested configured field does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityColumnDefinition", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"configuredField-workspace-{workspaceId}-get", "x-filename-id":"configuredfield-workspace-workspaceid-get" } }, "/configuredField/document/workspace/{workspaceId}":{ "get":{ "tags":[ "Configured Fields" ], "summary":"View File Configured Fields under a Workspace", "description":"This endpoint returns file configured fields that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
  • The configured fields are owned by this workspace or inherited from its parent workspace.
", "operationId":"/configuredField/document/workspace/{workspaceId}_getDocumentColumnDefinitionsByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested configured field does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityColumnDefinition", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"configuredField-document-workspace-{workspaceId}-get", "x-filename-id":"configuredfield-document-workspace-workspaceid-get" } }, "/configuredField/idea/workspace/{workspaceId}":{ "get":{ "tags":[ "Configured Fields" ], "summary":"View Idea Configured Fields under a Workspace", "description":"This endpoint returns idea configured fields that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
  • The configured fields are owned by this workspace or inherited from its parent workspace.
", "operationId":"/configuredField/idea/workspace/{workspaceId}_getIdeaColumnDefinitionsByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested configured field does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityColumnDefinition", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"configuredField-idea-workspace-{workspaceId}-get", "x-filename-id":"configuredfield-idea-workspace-workspaceid-get" } }, "/configuredField/program/workspace/{workspaceId}":{ "get":{ "tags":[ "Configured Fields" ], "summary":"View Program Configured Fields under a Workspace", "description":"This endpoint returns program configured fields that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
  • The configured fields are owned by this workspace or inherited from its parent workspace.
", "operationId":"/configuredField/program/workspace/{workspaceId}_getProgramColumnDefinitionsByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested configured field does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityColumnDefinition", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"configuredField-program-workspace-{workspaceId}-get", "x-filename-id":"configuredfield-program-workspace-workspaceid-get" } }, "/configuredField/strategy/workspace/{workspaceId}":{ "get":{ "tags":[ "Configured Fields" ], "summary":"View Strategy Configured Fields under a Workspace", "description":"This endpoint returns strategy configured fields that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
  • The configured fields are owned by this workspace or inherited from its parent workspace.
", "operationId":"/configuredField/strategy/workspace/{workspaceId}_getStrategyColumnDefinitionsByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested configured field does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityColumnDefinition", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"configuredField-strategy-workspace-{workspaceId}-get", "x-filename-id":"configuredfield-strategy-workspace-workspaceid-get" } }, "/configuredField/move":{ "put":{ "tags":[ "Configured Fields" ], "summary":"Change Owning Workspace of a Configured Field", "description":"Send a request to this endpoint to change the owning workspace of a configured field.", "operationId":"/configuredField/move_moveUDF", "requestBody":{ "description":"A entity with details to move or change the owning workspace of a configured field.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityConfiguredFieldMoveRequestInput", "$ref":"#/components/schemas/ApiEntityConfiguredFieldMoveRequestInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Configured Fields service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"configuredField-move-put", "x-filename-id":"configuredfield-move-put" } }, "/configuredField/replicateObjectInWorkspaces/configuredField/{columnDefinitionId}/workspace/{workspaceId}":{ "post":{ "tags":[ "Configured Fields" ], "summary":"Assign or Promote a Configured Field (Deprecated since 25.9)", "description":"Send a request to this endpoint to assign or promote a configured field within the same workspace hierarchy.", "operationId":"/configuredField/replicateObjectInWorkspaces/configuredField/{columnDefinitionId}/workspace/{workspaceId}_replicateConfiguredFieldInWorkspaceHierarchy", "parameters":[ { "name":"columnDefinitionId", "in":"path", "description":"The system-generated identifier of a configured field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"path", "description":"The system-generated identifier for the new owning workspace of the configured field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"objectType", "in":"query", "description":"This is a required field for PROGRAM, IDEA, STRATEGY, and DOCUMENT object types.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DOCUMENT", "IDEA", "PROGRAM", "STRATEGY" ] } } ], "responses":{ "404":{ "description":"The requested configured field does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "deprecated":true, "x-internal-id":"configuredField-replicateObjectInWorkspaces-configuredField-{columnDefinitionId}-workspace-{workspaceId}-post", "x-filename-id":"configuredfield-replicateobjectinworkspaces-configuredfield-columndefinitionid-workspace-workspaceid-post" } }, "/configuredField/list/values/sort":{ "post":{ "tags":[ "Configured Fields" ], "summary":"Sort Values of a List type Configured Field", "description":"This endpoint reorders the values of a list type configured field alpha-numerically either in ascending or descending order.

The required input combinations are:
For Configured Fields with flexObject as PROGRAM, DOCUMENT, IDEA or STRATEGY -
  • flexObject,columnDefinitionId
  • flexObject,viewColumnName,workspaceId
  • flexObject,viewColumnName,workspaceCode
  • flexObject,label,workspaceId
  • flexObject,label,workspaceCode

For Configured Fields with flexObject other than PROGRAM, DOCUMENT, IDEA or STRATEGY like PROJECT, ACTIVITY etc -
  • flexObject,columnDefinitionId
  • flexObject,viewColumnName
  • flexObject,label
", "operationId":"/configuredField/list/values/sort_sortListValues", "requestBody":{ "description":"List Type Configured Field Sort Input.

The required input combinations are:
For Configured Fields with flexObject as PROGRAM, DOCUMENT, IDEA or STRATEGY -
  • flexObject,columnDefinitionId
  • flexObject,viewColumnName,workspaceId
  • flexObject,viewColumnName,workspaceCode
  • flexObject,label,workspaceId
  • flexObject,label,workspaceCode

For Configured Fields with flexObject other than PROGRAM, DOCUMENT, IDEA or STRATEGY like PROJECT, ACTIVITY etc -
  • flexObject,columnDefinitionId
  • flexObject,viewColumnName
  • flexObject,label
", "content":{ "application/json":{ "schema":{ "title":"ApiEntityColumnDefinitionSortInput", "$ref":"#/components/schemas/ApiEntityColumnDefinitionSortInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Configured Fields service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"The object was successfully created." } }, "x-internal-id":"configuredField-list-values-sort-post", "x-filename-id":"configuredfield-list-values-sort-post" } }, "/configuredField/label":{ "put":{ "tags":[ "Configured Fields" ], "summary":"Update Localized Column Labels of an Inherited Configured Field", "description":"Send a request to this endpoint to update the localized column labels of a configured field in an inherited workspace.
Configured fields for Document, Program, Idea, and Strategy are not supported.", "operationId":"/configuredField/label_updateInInheritedWorkspace", "requestBody":{ "description":"A configured field object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityColumnDefinitionLabelInput", "$ref":"#/components/schemas/ApiEntityColumnDefinitionLabelInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Configured Fields service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"configuredField-label-put", "x-filename-id":"configuredfield-label-put" } }, "/constraint":{ "put":{ "tags":[ "Constraint" ], "summary":"Update a Constraint", "description":"Send a request to this endpoint to update a constraint.", "operationId":"/constraint_update_16", "requestBody":{ "description":"A task object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityConstraintInput", "$ref":"#/components/schemas/ApiEntityConstraintInput", "exampleSetFlag":false }, "examples":{ "Update_a_Constraint_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Constraint by Assigning Code Values Using Codes", "description":"Payload to update a constraint using the project code, workspace code, constraint code, and codeValues fields such as code value code and code type code.", "value":{ "constraintCode":"CSTR1", "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_Constraint":{ "summary":"Update a Using Constraint", "description":"Payload to update date identified and notes using constraint ID.", "value":{ "constraintId":218201, "dateIdentified":"2023-03-02T08:00:00", "notes":"Permissions general notes : visit website" }, "valueSetFlag":true }, "Update_a_Constraint_Using_Codes":{ "summary":"Update a Using Constraint Using Codes", "description":"Payload to update date identified and notes using the constraint code, project code, and workspace code.", "value":{ "constraintCode":"CSTR1", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "dateIdentified":"2023-03-01T08:00:00", "notes":"Permissions updated notes : visit website" }, "valueSetFlag":true }, "Update_a_Constraint_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Constraint by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update a constraint using the constraint ID and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "constraintId":304202, "codeValues":[ { "parentId":298203, "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_Constraint_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Constraint by Assigning Code Values Using IDs", "description":"Payload to update a constraint using the constraint ID, and codeValues fields such as code value ID and code type ID.", "value":{ "constraintId":304202, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_an_Constraint_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update an Constraint by Assigning Multiple Code Values Using IDs", "description":"Payload to update a constraint using the constraint ID and codeValues fields such as code value ID and code type ID.", "value":{ "constraintId":304202, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Constraint service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"constraint-put", "x-filename-id":"constraint-put" }, "post":{ "tags":[ "Constraint" ], "summary":"Create a Constraint", "description":"Send a request to this endpoint to create a constraint.", "operationId":"/constraint_create_17", "requestBody":{ "description":"A constraint object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityConstraintInput", "$ref":"#/components/schemas/ApiEntityConstraintInput", "exampleSetFlag":false }, "examples":{ "Create_a_Constraint_Using_Codes":{ "summary":"Create a Constraint Using Codes", "description":"Payload to create a constraint using the project code, workspace code, constraint code, constraint name, date identified, notes, project company name, and constraint type.", "value":{ "constraintName":"RFI", "constraintCode":"CSTR2", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "constraintType":"DESIGN_ISSUE", "notes":"RFI - CSTR2", "companyName":"stable3a", "dateIdentified":"2023-03-07T08:00:00" }, "valueSetFlag":true }, "Create_a_Constraint_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Constraint by Assigning Code Values Using Codes", "description":"Payload to create a constraint using the project code, workspace code, constraint code, constraint name, and codeValues fields such as code value code and code type code.", "value":{ "constraintCode":"CSTR1", "constraintName":"Permits", "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Create_a_Constraint_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create a Constraint by Assigning Code Values Using IDs", "description":"Payload to create a constraint using the project ID, constraint code, constraint name, and codeValues fields such as code value ID and code type ID.", "value":{ "constraintCode":"CSTR1", "constraintName":"Permits", "projectId":2899701, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Create_a_Constraint":{ "summary":"Create a Constraint", "description":"Payload to create a constraint using the project ID, constraint code, constraint name, date identified, notes, project company ID, and constraint type.", "value":{ "constraintName":"Permits", "constraintCode":"CSTR1", "projectId":1888907, "constraintType":"ACCESS", "notes":"Permits - CSTR1", "projectCompanyId":1996707, "dateIdentified":"2023-03-09T08:00:00" }, "valueSetFlag":true }, "Create_a_Constraint_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Constraint by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a constraint using the project code, workspace code, constraint code, constraint name, and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "constraintCode":"CSTR1", "constraintName":"Permits", "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "codeValues":[ { "parentId":298203, "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Create_a_Constraint_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Constraint by Assigning Multiple Code Values Using IDs", "description":"Payload to create a constraint using the project ID, constraint code, constraint name, and codeValues fields such as code value ID and code type ID.", "value":{ "constraintCode":"CSTR1", "constraintName":"Permits", "projectId":2899701, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Constraint service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityConstraint", "$ref":"#/components/schemas/ApiEntityConstraint", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"constraint-post", "x-filename-id":"constraint-post" } }, "/constraint/batch":{ "put":{ "tags":[ "Constraint" ], "summary":"Batch Update Constraints ", "description":"Send a request to this endpoint to update one or more constraints.", "operationId":"/constraint/batch_updateBatch_15", "requestBody":{ "description":"One or more constraint objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityConstraintInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Constraints_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Constraints by Assigning Code Values Using Codes or IDs", "description":"Payload to update constraints using the constraint ID and codeValues fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "constraintId":436446 }, { "codeValues":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "constraintId":436447 } ], "valueSetFlag":true }, "Batch_Update_Constraints":{ "summary":"Batch Update Using Constraint IDs", "description":"Payload to update date identified of one or more constraints using the constraint IDs.", "value":[ { "constraintId":218204, "dateIdentified":"2023-03-10T08:00:00" }, { "constraintId":218204, "dateIdentified":"2023-03-11T08:00:00" } ], "valueSetFlag":true }, "Batch_Update_Constraints_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Constraints by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update constraints using the constraint ID and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "constraintId":436448 }, { "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "constraintId":436449 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Constraint service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"constraint-batch-put", "x-filename-id":"constraint-batch-put" }, "post":{ "tags":[ "Constraint" ], "summary":"Batch Create Constraints", "description":"Send a request to this endpoint to create one or more constraints. ", "operationId":"/constraint/batch_createBatch_17", "requestBody":{ "description":"One or more constraint objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityConstraintInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Constraints":{ "summary":"Batch Create Constraint IDs", "description":"Payload to create one or more constraints using the project ID, project company ID, constraint code, constraint name, constraint type, and date identified.", "value":[ { "constraintName":"Specialized Equipment unavailable", "constraintCode":"CSTR3", "projectId":1888907, "constraintType":"EQUIPMENT", "projectCompanyId":1996707, "dateIdentified":"2023-03-04T08:00:00" }, { "constraintName":"Site plan not approved ", "constraintCode":"CSTR4", "projectId":1888907, "constraintType":"ACCESS", "projectCompanyId":1996707, "dateIdentified":"2023-03-02T08:00:00" } ], "valueSetFlag":true }, "Batch_Create_Constraints_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Constraints by Assigning Code Values Using Codes", "description":"Payload to create constraints using the project code, workspace code, constraint code, constraint name, and codeValues fields such as code value code and code type code.", "value":[ { "constraintCode":"CSTR1", "constraintName":"Permits", "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ] }, { "constraintCode":"CSTR2", "constraintName":"RFI", "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "codeValues":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ] } ], "valueSetFlag":true }, "Batch_Create_Constraints_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Constraints by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create constraints using the project code, workspace code, constraint code, constraint name, and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "constraintCode":"CSTR1", "constraintName":"Permits", "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, { "constraintCode":"CSTR2", "constraintName":"RFI", "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Constraint service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityConstraint", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"constraint-batch-post", "x-filename-id":"constraint-batch-post" }, "delete":{ "tags":[ "Constraint" ], "summary":"Batch Delete Constraints ", "description":"Send a request to this endpoint to delete one or more constraints.", "operationId":"/constraint/batch_deleteBatch_17", "requestBody":{ "description":"One or more system-generated identifiers of constraints.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Constraint service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"constraint-batch-delete", "x-filename-id":"constraint-batch-delete" } }, "/constraint/{constraintId}":{ "get":{ "tags":[ "Constraint" ], "summary":"View a Constraint ", "description":"This endpoint returns constraints that meet the following requirements:
  • The object is associated with a task with an ID value that matches the value of the {workManagerTaskId} path parameter.
", "operationId":"/constraint/{constraintId}_find_19", "parameters":[ { "name":"constraintId", "in":"path", "description":"The system-generated identifier of a constraint.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested constraint does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityConstraint", "$ref":"#/components/schemas/ApiEntityConstraint", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"constraint-{constraintId}-get", "x-filename-id":"constraint-constraintid-get" }, "delete":{ "tags":[ "Constraint" ], "summary":"Delete a Constraint ", "description":"Send a request to this endpoint to delete a constraint. The application object with an ID value that matches the value of the {constraintId} path parameter will be deleted.", "operationId":"/constraint/{constraintId}_delete_17", "parameters":[ { "name":"constraintId", "in":"path", "description":"The system-generated identifier of a task.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Constraint service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"constraint-{constraintId}-delete", "x-filename-id":"constraint-constraintid-delete" } }, "/constraint/code/{constraintCode}":{ "get":{ "tags":[ "Constraint" ], "summary":"View all Constraints by Code", "description":"This endpoint returns constraints that meet the following requirements:
    ${constraintCode}
", "operationId":"/constraint/code/{constraintCode}_findByCode_5", "parameters":[ { "name":"constraintCode", "in":"path", "description":"The user-specified identifier of a constraint.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested constraint does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityConstraint", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"constraint-code-{constraintCode}-get", "x-filename-id":"constraint-code-constraintcode-get" } }, "/constraint/workspace/{workspaceCode}/project/{projectCode}":{ "get":{ "tags":[ "Constraint" ], "summary":"View a Constraint by Workspace and Project Code", "description":"This endpoint returns constraints that meet the following requirements:
    ${projectCode} ${workspaceCode}
", "operationId":"/constraint/workspace/{workspaceCode}/project/{projectCode}_findByCodeAndWorkspace_2", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"path", "description":"The user-specified identifier of a project.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested constraint does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityConstraint", "$ref":"#/components/schemas/ApiEntityConstraint", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"constraint-workspace-{workspaceCode}-project-{projectCode}-get", "x-filename-id":"constraint-workspace-workspacecode-project-projectcode-get" } }, "/constraint/project/{projectId}":{ "get":{ "tags":[ "Constraint" ], "summary":"View all Constraints by Project", "description":"This endpoint returns constraints that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {project} path parameter.
", "operationId":"/constraint/project/{projectId}_findByProjectId_1", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested constraint does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityConstraint", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"constraint-project-{projectId}-get", "x-filename-id":"constraint-project-projectid-get" } }, "/constraint/workManagerTask/{workManagerTaskId}":{ "get":{ "tags":[ "Constraint" ], "summary":"View all Constraints by Task", "description":"This endpoint returns constraints that meet the following requirements:
  • The object is associated with a task with an ID value that matches the value of the {workManagerTaskId} path parameter.
", "operationId":"/constraint/workManagerTask/{workManagerTaskId}_findByWorkManagerTaskId", "parameters":[ { "name":"workManagerTaskId", "in":"path", "description":"The system-generated identifier of a task.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested constraint does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityConstraint", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"constraint-workManagerTask-{workManagerTaskId}-get", "x-filename-id":"constraint-workmanagertask-workmanagertaskid-get" } }, "/constraint/syncBatch":{ "post":{ "tags":[ "Constraint" ], "summary":"Batch Sync Constraints", "description":"Send a request to this endpoint to create or update one or more constraints.", "operationId":"/constraint/syncBatch_syncBatch_17", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any constraint record sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more constraint objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityConstraintInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Constraints_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create or Update Constraints by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update constraints using the project code, workspace code, activity code, activity name, activity ID, and codeValuesActivity fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "constraintCode":"CSTR2", "constraintName":"RFI", "projectCode":"New Town - City Mall", "workspaceCode":"Asia" }, { "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "constraintId":244756 } ], "valueSetFlag":true }, "Create_or_Update_a_Constraint":{ "summary":"Create or Update a Constraint", "description":"Payload to create or update a constraint using the project ID, constraint code, constraint name, date identified, notes, project company ID, and constraint type.", "value":[ { "constraintName":"Permits", "constraintCode":"CSTR1", "projectId":1888907, "constraintType":"ACCESS", "notes":"Permits - CSTR1", "projectCompanyId":1996707, "dateIdentified":"2023-03-09T08:00:00" } ], "valueSetFlag":true }, "Create_or_Update_Constraints_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create or Update Constraints by Assigning Code Values Using Codes", "description":"Payload to create or update constraints using the project code, workspace code, constraint code, constraint name, constraint ID, and codeValues fields such as code value code and code type code.", "value":[ { "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ], "constraintCode":"CSTR2", "constraintName":"RFI", "projectCode":"New Town - City Mall", "workspaceCode":"Asia" }, { "codeValues":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "constraintId":244756 } ], "valueSetFlag":true }, "Create_or_Update_a_Constraint_Using_Codes":{ "summary":"Create or Update a Constraint Using Codes", "description":"Payload to create or update a constraint using the project code, workspace code, constraint code, constraint name, date identified, notes, project company name, and constraint type.", "value":[ { "constraintName":"RFI", "constraintCode":"CSTR2", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "constraintType":"DESIGN_ISSUE", "notes":"RFI - CSTR2", "companyName":"stable3a", "dateIdentified":"2023-03-07T08:00:00" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"constraint-syncBatch-post", "x-filename-id":"constraint-syncbatch-post" } }, "/costCategory":{ "get":{ "tags":[ "Cost Category" ], "summary":"View Cost Categories by Cost Category Type", "description":"Send a request to this endpoint to get cost categories of the type mentioned in the query parameter.", "operationId":"/costCategory_getCostCategoriesByCostCategoryType", "parameters":[ { "name":"type", "in":"query", "description":"CostCategoryType to get Cost categories.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EQUIPMENT", "LABOR", "MATERIALS", "OTHER" ] } } ], "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCostCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-get", "x-filename-id":"costcategory-get" }, "put":{ "tags":[ "Cost Category" ], "summary":"Update a Cost Category ", "description":"Send a request to this endpoint to update a cost category. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/costCategory_update_17", "requestBody":{ "description":"Cost Category to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCostCategoryInput", "$ref":"#/components/schemas/ApiEntityCostCategoryInput", "exampleSetFlag":false }, "examples":{ "Update_a_Cost_Category_using_Cost_Category_ID":{ "summary":"Update a Cost Category using Cost Category ID", "description":"Payload to update type of a cost category using cost category ID.", "value":{ "costCategoryId":10001, "type":"MATERIALS" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Cost Category service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"costCategory-put", "x-filename-id":"costcategory-put" }, "post":{ "tags":[ "Cost Category" ], "summary":"Create a Cost Category", "description":"Send a request to this endpoint to create a cost category. An application object will be created using the JSON data provided in the request body.", "operationId":"/costCategory_create_18", "requestBody":{ "description":"Cost Category to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCostCategoryInput", "$ref":"#/components/schemas/ApiEntityCostCategoryInput", "exampleSetFlag":false }, "examples":{ "Create_a_Cost_Category":{ "summary":"Create a Cost Category", "description":"Payload to create a cost category using workspace ID, abbreviation, type, and cost category name.", "value":{ "abbreviation":"USD", "type":"LABOR", "costCategoryName":"US - Dollar", "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Cost Category service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCostCategory", "$ref":"#/components/schemas/ApiEntityCostCategory", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-post", "x-filename-id":"costcategory-post" } }, "/costCategory/batch":{ "put":{ "tags":[ "Cost Category" ], "summary":"Batch Update Cost Categories ", "description":"Send a request to this endpoint to update one or more cost categories. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/costCategory/batch_updateBatch_16", "requestBody":{ "description":"Cost Categories to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCostCategoryInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Cost_Categories_using_Cost_Category_IDs":{ "summary":"Batch Update Cost Categories using Cost Category IDs", "description":"Payload to update type of one or more cost categories using cost category IDs.", "value":[ { "costCategoryId":10001, "type":"MATERIALS" }, { "costCategoryId":10002, "type":"MATERIALS" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Cost Category service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"costCategory-batch-put", "x-filename-id":"costcategory-batch-put" }, "post":{ "tags":[ "Cost Category" ], "summary":"Batch Create Cost Categories", "description":"Send a request to this endpoint to create one or more cost categories. An application object will be created for each JSON object provided in the request body.", "operationId":"/costCategory/batch_createBatch_18", "requestBody":{ "description":"Cost Category to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCostCategoryInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Cost_Categories":{ "summary":"Batch Create Cost Categories", "description":"Payload to create one or more cost categories using workspace ID, abbreviation, type, and cost category name.", "value":[ { "abbreviation":"USD", "type":"LABOR", "costCategoryName":"US - Dollar", "workspaceId":666603 }, { "abbreviation":"INR", "type":"LABOR", "costCategoryName":"IN - Rupees", "workspaceId":666603 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Cost Category service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCostCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-batch-post", "x-filename-id":"costcategory-batch-post" }, "delete":{ "tags":[ "Cost Category" ], "summary":"Batch Delete Cost Categories", "description":"Send a request to this endpoint to delete one or more cost categories. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/costCategory/batch_deleteBatch_18", "requestBody":{ "description":"IDs of Cost Category to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Cost Category service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"costCategory-batch-delete", "x-filename-id":"costcategory-batch-delete" } }, "/costCategory/{costCategoryId}":{ "get":{ "tags":[ "Cost Category" ], "summary":"View a Cost Category ", "description":"This endpoint returns a cost category. that meet the following requirements:
  • The object is associated with a cost category with an ID value that matches the value of the {costCategoryId} path parameter.
", "operationId":"/costCategory/{costCategoryId}_find_20", "parameters":[ { "name":"costCategoryId", "in":"path", "description":"ID of Cost Category to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested cost category does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCostCategory", "$ref":"#/components/schemas/ApiEntityCostCategory", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-{costCategoryId}-get", "x-filename-id":"costcategory-costcategoryid-get" }, "delete":{ "tags":[ "Cost Category" ], "summary":"Delete a Cost Category ", "description":"Send a request to this endpoint to delete a cost category. The application object with an ID value that matches the value of the {costCategoryId} path parameter will be deleted.", "operationId":"/costCategory/{costCategoryId}_delete_18", "parameters":[ { "name":"costCategoryId", "in":"path", "description":"ID of Cost Category to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Cost Category service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"costCategory-{costCategoryId}-delete", "x-filename-id":"costcategory-costcategoryid-delete" } }, "/costCategory/name/{costCategoryName}":{ "get":{ "tags":[ "Cost Category" ], "summary":"View a Cost Category by Name", "description":"This endpoint returns a cost category. that meet the following requirements:
  • The object has a name that matches the value of the {costCategoryName} path parameter.
", "operationId":"/costCategory/name/{costCategoryName}_findByName_3", "parameters":[ { "name":"costCategoryName", "in":"path", "description":"Name of Cost Category to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested cost category does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCostCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-name-{costCategoryName}-get", "x-filename-id":"costcategory-name-costcategoryname-get" } }, "/costCategory/workspace/{workspaceId}/name/{costCategoryName}":{ "get":{ "tags":[ "Cost Category" ], "summary":"View a Cost Category by Name and Workspace", "description":"This endpoint returns cost categories that meet the following requirements:
  • The object has a name that matches the value of the {costCategoryName} path parameter.
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/costCategory/workspace/{workspaceId}/name/{costCategoryName}_findByNameAndWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated unique identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"costCategoryName", "in":"path", "description":"Name of Cost Category to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested cost category does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCostCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-workspace-{workspaceId}-name-{costCategoryName}-get", "x-filename-id":"costcategory-workspace-workspaceid-name-costcategoryname-get" } }, "/costCategory/categoryRow/costCategory/{costCategoryName}/project/{projectId}":{ "get":{ "tags":[ "Cost Category" ], "summary":"View Cost Category Rows by Cost Category Name and Project", "description":"This endpoint returns cost category rows that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/costCategory/categoryRow/costCategory/{costCategoryName}/project/{projectId}_findCategoryRowByCategoryAndProject", "parameters":[ { "name":"costCategoryName", "in":"path", "description":"The name of a cost category.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectId", "in":"path", "description":"Project Id for which cost category row has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested cost category does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetCategoryRow", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-categoryRow-costCategory-{costCategoryName}-project-{projectId}-get", "x-filename-id":"costcategory-categoryrow-costcategory-costcategoryname-project-projectid-get" } }, "/costCategory/categoryRow/costCategory/{costCategoryId}":{ "get":{ "tags":[ "Cost Category" ], "summary":"View a Cost Category Row", "description":"This endpoint returns cost categories that meet the following requirements:
  • The object is associated with a cost category with an ID value that matches the value of the {costCategoryId} path parameter.
", "operationId":"/costCategory/categoryRow/costCategory/{costCategoryId}_findCategoryRowByCategoryId", "parameters":[ { "name":"costCategoryId", "in":"path", "description":"The system-generated unique identifier of a cost category.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested cost category does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetCategoryRow", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-categoryRow-costCategory-{costCategoryId}-get", "x-filename-id":"costcategory-categoryrow-costcategory-costcategoryid-get" } }, "/costCategory/categoryRow/sheetCode/{cbsSheetCodeId}":{ "get":{ "tags":[ "Cost Category" ], "summary":"View Cost Category Rows by CBS Sheet Code", "description":"This endpoint returns cost category rows that meet the following requirements:
  • The object has a cbs sheet code with a value that matches the value of the {cbsSheetCodeId} path parameter.
", "operationId":"/costCategory/categoryRow/sheetCode/{cbsSheetCodeId}_findCategoryRowByCbsSheetCodeId", "parameters":[ { "name":"cbsSheetCodeId", "in":"path", "description":"The system-generated unique identifier of a CBS sheet code.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested cost category does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetCategoryRow", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-categoryRow-sheetCode-{cbsSheetCodeId}-get", "x-filename-id":"costcategory-categoryrow-sheetcode-cbssheetcodeid-get" } }, "/costCategory/categoryRow/costSheet/{costSheetId}":{ "get":{ "tags":[ "Cost Category" ], "summary":"View a Cost Category Row by Cost Sheet ", "description":"This endpoint returns a cost category row that belongs to a cost sheet with an ID value that matches the value of the {costSheetId} path parameter.", "operationId":"/costCategory/categoryRow/costSheet/{costSheetId}_findCategoryRowBySheetId", "parameters":[ { "name":"costSheetId", "in":"path", "description":"The system-generated unique identifier of a cost sheet.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested cost category does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetCategoryRow", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-categoryRow-costSheet-{costSheetId}-get", "x-filename-id":"costcategory-categoryrow-costsheet-costsheetid-get" } }, "/costCategory/workspace/{workspaceId}":{ "get":{ "tags":[ "Cost Category" ], "summary":"View Cost Categories by Workspace ", "description":"This endpoint returns cost categories that belong to a workspace with an ID value that matches the value of the {workspaceId} path parameter.", "operationId":"/costCategory/workspace/{workspaceId}_getCostCategoriesForWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested cost category does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCostCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-workspace-{workspaceId}-get", "x-filename-id":"costcategory-workspace-workspaceid-get" } }, "/costCategory/syncBatch":{ "post":{ "tags":[ "Cost Category" ], "summary":"Batch Sync Cost Categories", "description":"Send a request to this endpoint to create or update one or more cost categories.", "operationId":"/costCategory/syncBatch_syncBatch_18", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any cost category sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more cost category objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCostCategoryInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Cost_Category":{ "summary":"Create or Update Cost Category", "description":"Payload to create or update the cost category using the workspace ID, abbreviation, type, and cost category name.", "value":[ { "abbreviation":"USD", "type":"LABOR", "costCategoryName":"US - Dollar", "workspaceId":726701 }, { "abbreviation":"INR", "type":"EQUIPMENT", "costCategoryName":"IN - Rupees", "workspaceId":726701 } ], "valueSetFlag":true }, "Create_or_Update_Cost_Category_Using_Workspace_Code":{ "summary":"Create or Update Cost Category Using Workspace Code", "description":"Payload to create or update the cost category using the workspace code, push down type which can be manual or automatic, abbreviation, type, and cost category name.", "value":[ { "abbreviation":"USD", "type":"LABOR", "costCategoryName":"US - Dollar", "workspaceCode":"North America", "pushDownType":"AUTOMATIC" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Cost Category service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"costCategory-syncBatch-post", "x-filename-id":"costcategory-syncbatch-post" } }, "/currency":{ "put":{ "tags":[ "Currency" ], "summary":"Update a Currency", "description":"Send a request to this endpoint to update a currency. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/currency_update_18", "requestBody":{ "description":"Currency to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurrencyInput", "$ref":"#/components/schemas/ApiEntityCurrencyInput", "exampleSetFlag":false }, "examples":{ "Update_a_Currency_Using_Calendar_ID":{ "summary":"Update a Currency Using Calendar ID", "description":"Payload to update name of a currency using currency ID.", "value":{ "currencyId":244002, "currencyName":"US Dollar" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Currency service. Verify the request contains valid data, then resubmit the request. " }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"currency-put", "x-filename-id":"currency-put" }, "post":{ "tags":[ "Currency" ], "summary":"Create a Currency", "description":"Send a request to this endpoint to create a currency. An application object will be created using the JSON data provided in the request body.", "operationId":"/currency_create_19", "requestBody":{ "description":"Currency to be created", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurrencyInput", "$ref":"#/components/schemas/ApiEntityCurrencyInput", "exampleSetFlag":false }, "examples":{ "Create_a_Currency":{ "summary":"Create a Currency", "description":"Payload to create a currency using workspace ID, currency code, currency name, currency symbol, and decimals to display.", "value":{ "currencyCode":"USD", "currencyName":"US Dollar - New", "currencySymbol":"$", "decimalsToDisplay":2, "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Currency service. Verify the request contains valid data, then resubmit the request. " }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurrency", "$ref":"#/components/schemas/ApiEntityCurrency", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"currency-post", "x-filename-id":"currency-post" } }, "/currency/{currencyId}":{ "get":{ "tags":[ "Currency" ], "summary":"View a Currency", "description":"This endpoint returns currencies that meet the following requirements:
  • The object is associated with a currency with an ID value that matches the value of the {currencyId} path parameter.
", "operationId":"/currency/{currencyId}_find_21", "parameters":[ { "name":"currencyId", "in":"path", "description":"ID of the currency to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested currency does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurrency", "$ref":"#/components/schemas/ApiEntityCurrency", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"currency-{currencyId}-get", "x-filename-id":"currency-currencyid-get" }, "delete":{ "tags":[ "Currency" ], "summary":"Delete a Currency", "description":"Send a request to this endpoint to delete a currency. The application object with an ID value that matches the value of the {currencyId} path parameter will be deleted.", "operationId":"/currency/{currencyId}_delete_19", "parameters":[ { "name":"currencyId", "in":"path", "description":"ID of the currency to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Currency service. Verify the request contains valid data, then resubmit the request. " }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"currency-{currencyId}-delete", "x-filename-id":"currency-currencyid-delete" } }, "/currency/code/{currencyCode}":{ "get":{ "tags":[ "Currency" ], "summary":"View a Currency by Code", "description":"This endpoint returns currencies that meet the following requirements:
  • The object has a code that matches the value of the {currencyCode} path parameter.
", "operationId":"/currency/code/{currencyCode}_findByCode_6", "parameters":[ { "name":"currencyCode", "in":"path", "description":"The user-specified identifier of a currency.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested currency does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurrency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"currency-code-{currencyCode}-get", "x-filename-id":"currency-code-currencycode-get" } }, "/currency/name/{currencyName}":{ "get":{ "tags":[ "Currency" ], "summary":"View a Currency by Name", "description":"This endpoint returns a currency that meet the following requirements:
  • The object has a name that matches the value of the {currencyName} path parameter.
", "operationId":"/currency/name/{currencyName}_findByName_4", "parameters":[ { "name":"currencyName", "in":"path", "description":"Name of the currency to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested currency does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurrency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"currency-name-{currencyName}-get", "x-filename-id":"currency-name-currencyname-get" } }, "/currency/currencySeed":{ "get":{ "tags":[ "Currency" ], "summary":"View a Currency Seed", "description":"This endpoint returns currency seed data.", "operationId":"/currency/currencySeed_getCurrencySeed", "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurrencySeed", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"currency-currencySeed-get", "x-filename-id":"currency-currencyseed-get" } }, "/currency/workspace/{workspaceId}":{ "get":{ "tags":[ "Currency" ], "summary":"View Currencies by Workspace", "description":"This endpoint returns currencies that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/currency/workspace/{workspaceId}_getWorkspaceCurrencies", "parameters":[ { "name":"workspaceId", "in":"path", "description":"Id of Currency to be found", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested currency does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurrency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"currency-workspace-{workspaceId}-get", "x-filename-id":"currency-workspace-workspaceid-get" } }, "/curve":{ "put":{ "tags":[ "Curve" ], "summary":"Update a Curve", "description":"Send a request to this endpoint to update a curve. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/curve_update_19", "requestBody":{ "description":"Curve to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurveInput", "$ref":"#/components/schemas/ApiEntityCurveInput", "exampleSetFlag":false }, "examples":{ "Update_a_Curve_Using_Curve_ID":{ "summary":"Update a Curve Using Curve ID", "description":"Payload to update name of a curve using curve ID.", "value":{ "curveName":"New Bell Curve", "curveId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Curve service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"curve-put", "x-filename-id":"curve-put" }, "post":{ "tags":[ "Curve" ], "summary":"Create a Curve", "description":"Send a request to this endpoint to create a curve. An application object will be created using the JSON data provided in the request body.", "operationId":"/curve_create_20", "requestBody":{ "description":"Curve that has to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurveInput", "$ref":"#/components/schemas/ApiEntityCurveInput", "exampleSetFlag":false }, "examples":{ "Create_a_Curve":{ "summary":"Create a Curve", "description":"Payload to create a curve using workspace ID, and curve name.", "value":{ "curveName":"Bell Curve", "workspaceId":666603 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Curve service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurve", "$ref":"#/components/schemas/ApiEntityCurve", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"curve-post", "x-filename-id":"curve-post" } }, "/curve/batch":{ "put":{ "tags":[ "Curve" ], "summary":"Batch Update Curves", "description":"Send a request to this endpoint to update one or more curves. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/curve/batch_updateBatch_17", "requestBody":{ "description":"Curves to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurveInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Curves_Using_Curve_ID":{ "summary":"Batch Update Curves Using Curve ID", "description":"Payload to update name of one or more curves using curve ID.", "value":[ { "curveName":"New Bell Curve", "curveId":10001 }, { "curveName":"New Double Bell Curve", "curveId":10002 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Curve service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"curve-batch-put", "x-filename-id":"curve-batch-put" }, "post":{ "tags":[ "Curve" ], "summary":"Batch Create Curves", "description":"Send a request to this endpoint to create one or more curves. An application object will be created for each JSON object provided in the request body.", "operationId":"/curve/batch_createBatch_19", "requestBody":{ "description":"Curves that have to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurveInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Curves":{ "summary":"Batch Create Curves", "description":"Payload to create one or more curves using workspace ID, and curve name.", "value":[ { "curveName":"Bell Curve", "workspaceId":666603 }, { "curveName":"Double Bell Curve", "workspaceId":666603 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Curve service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurve", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"curve-batch-post", "x-filename-id":"curve-batch-post" }, "delete":{ "tags":[ "Curve" ], "summary":"Batch Delete Curves", "description":"Send a request to this endpoint to delete one or more curves. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/curve/batch_deleteBatch_19", "requestBody":{ "description":"IDs of the curves that have to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Curve service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"curve-batch-delete", "x-filename-id":"curve-batch-delete" } }, "/curve/{curveId}":{ "get":{ "tags":[ "Curve" ], "summary":"View a Curve", "description":"This endpoint returns a curve that meet the following requirements:
  • The object has an ID that matches the value of the {curveId} path parameter.
", "operationId":"/curve/{curveId}_find_22", "parameters":[ { "name":"curveId", "in":"path", "description":"ID of the curve that has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested curve does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurve", "$ref":"#/components/schemas/ApiEntityCurve", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"curve-{curveId}-get", "x-filename-id":"curve-curveid-get" }, "delete":{ "tags":[ "Curve" ], "summary":"Delete a Curve", "description":"Send a request to this endpoint to delete a curve. The application object with an ID value that matches the value of the {curveId} path parameter will be deleted.", "operationId":"/curve/{curveId}_delete_20", "parameters":[ { "name":"curveId", "in":"path", "description":"ID of the curve that has to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Curve service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"curve-{curveId}-delete", "x-filename-id":"curve-curveid-delete" } }, "/curve/name/{curveName}":{ "get":{ "tags":[ "Curve" ], "summary":"View a Curve by Name", "description":"This endpoint returns a curve that meet the following requirements:
  • The object has a code that matches the value of the {curveName} path parameter.
", "operationId":"/curve/name/{curveName}_findBName", "parameters":[ { "name":"curveName", "in":"path", "description":"Name of the curve that has to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested curve does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurve", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"curve-name-{curveName}-get", "x-filename-id":"curve-name-curvename-get" } }, "/curve/workspace/{workspaceId}":{ "get":{ "tags":[ "Curve" ], "summary":"View a Curve by Workspace", "description":"This endpoint returns curves that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/curve/workspace/{workspaceId}_findByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"ID of the workspace for which curve has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested curve does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurve", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"curve-workspace-{workspaceId}-get", "x-filename-id":"curve-workspace-workspaceid-get" } }, "/curve/workspace/{workspaceId}/name/{curveName}":{ "get":{ "tags":[ "Curve" ], "summary":"View a Curve by Workspace and Name", "description":"This endpoint returns curves that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
  • The object has a code that matches the value of the {curveName} path parameter.
", "operationId":"/curve/workspace/{workspaceId}/name/{curveName}_findByWorkspaceAndName", "parameters":[ { "name":"workspaceId", "in":"path", "description":"ID of workspace and name of the curve that has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"curveName", "in":"path", "description":"curveName of curve to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested curve does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurve", "$ref":"#/components/schemas/ApiEntityCurve", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"curve-workspace-{workspaceId}-name-{curveName}-get", "x-filename-id":"curve-workspace-workspaceid-name-curvename-get" } }, "/curve/syncBatch":{ "post":{ "tags":[ "Curve" ], "summary":"Batch Sync Curves", "description":"Send a request to this endpoint to create or update one or more curves.", "operationId":"/curve/syncBatch_syncBatch_19", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any curve sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more curve objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurveInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Curves":{ "summary":"Create or Update Curves", "description":"Payload to create or update a curve using the workspace ID, push down type which can be manual or automatic, curve name, and buckets such as bucket level and value.", "value":[ { "pushDownType":"MANUAL", "workspaceId":4001, "curveName":"Linear-1", "buckets":[ { "bucketLevel":0, "value":0 }, { "bucketLevel":20, "value":5 }, { "bucketLevel":40, "value":5 }, { "bucketLevel":60, "value":5 }, { "bucketLevel":80, "value":5 }, { "bucketLevel":100, "value":5 } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Curve service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"curve-syncBatch-post", "x-filename-id":"curve-syncbatch-post" } }, "/dictionary/manageSharedData":{ "post":{ "tags":[ "Dictionary" ], "summary":"Manage the Shared Data of Dictionary Objects", "description":"Send a request to the endpoint to assign, unassign, and promote the various dictionary objects to different workspaces. This endpoint will work only for managing the shared data of records that are owned by workspace.", "operationId":"/dictionary/manageSharedData_replicateCurveInWorkspace", "requestBody":{ "description":"A combined assign and unassign request for all the dictionary objects.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCombinedAssignUnassignRequest", "$ref":"#/components/schemas/ApiEntityCombinedAssignUnassignRequest", "exampleSetFlag":false }, "examples":{ "Promote_a_Calendar_to_Parent_Workspace":{ "summary":"Promote a Calendar to Parent Workspace", "description":"Payload to promote a calendar from a child workspace to a parent workspace.", "value":{ "calendars":[ { "workspaces":[ { "workspaceId":101, "action":"ASSIGN" } ], "objectIdentifier":{ "calendarId":10001 } } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"The requested curve does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"dictionary-manageSharedData-post", "x-filename-id":"dictionary-manageshareddata-post" } }, "/discussion/activity/project/{projectId}":{ "get":{ "tags":[ "Discussion" ], "summary":"View all Activity Discussions by Project", "description":"This endpoint returns activity discussions that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/discussion/activity/project/{projectId}_findActivityDiscussionsByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested discussions does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityDiscussion", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"discussion-activity-project-{projectId}-get", "x-filename-id":"discussion-activity-project-projectid-get" } }, "/discussion/activity/{activityId}":{ "get":{ "tags":[ "Discussion" ], "summary":"View all Discussions by Activity ", "description":"This endpoint returns discussions that meet the following requirements:
    {activityId}
", "operationId":"/discussion/activity/{activityId}_findDiscussionsByActivity", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested discussions does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityDiscussion", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"discussion-activity-{activityId}-get", "x-filename-id":"discussion-activity-activityid-get" } }, "/discussion/task/{taskId}":{ "get":{ "tags":[ "Discussion" ], "summary":"View all Discussions by Task ", "description":"This endpoint returns discussions that meet the following requirements:
    {workManagerTaskId}
", "operationId":"/discussion/task/{taskId}_findDiscussionsByTask", "parameters":[ { "name":"taskId", "in":"path", "description":"The system-generated identifier of a task.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested discussions does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityTaskDiscussion", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"discussion-task-{taskId}-get", "x-filename-id":"discussion-task-taskid-get" } }, "/discussion/task/project/{projectId}":{ "get":{ "tags":[ "Discussion" ], "summary":"View all Task Discussions by Project ", "description":"This endpoint returns task discussions that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/discussion/task/project/{projectId}_findTaskDiscussionsByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested discussions does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityTaskDiscussion", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"discussion-task-project-{projectId}-get", "x-filename-id":"discussion-task-project-projectid-get" } }, "/document/assignUser":{ "post":{ "tags":[ "Document" ], "summary":"Assign Permission Profiles To User", "description":"Use this endpoint to assign document permission profiles to multiple user.", "operationId":"/document/assignUser_assignUser_1", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when validating any user permission profile sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with document and user profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocumentUserPermissions", "$ref":"#/components/schemas/ApiEntityDocumentUserPermissions", "exampleSetFlag":false }, "examples":{ "Assign_File_Permission_Profiles_to_Multiple_Users_Using_Codes":{ "summary":"Assign File Permission Profiles to Multiple Users Using Codes", "description":"Payload to assign file permission to multiple users using scope id, scope, path, and profiles such as user name and document profile ID.", "value":{ "scope":"project", "scopeId":1362804, "path":"New Town - City Mall", "workspaceId":1098902, "profiles":[ { "userName":"manager@example.com", "documentProfileId":"16" }, { "userName":"supervisor@example.com", "documentProfileId":"16" } ] }, "valueSetFlag":true }, "Assign_File_Permission_Profiles_to_Multiple_Users_Using_IDs":{ "summary":"Assign File Permission Profiles to Multiple Users Using IDs", "description":"Payload to assign file permission to multiple users using mandatory fields such as document ID, user name, and document profile ID.", "value":{ "documentId":26404, "profiles":[ { "userName":"manager@example.com", "documentProfileId":"16" }, { "userName":"supervisor@example.com", "documentProfileId":"16" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocumentUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityDocumentUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-assignUser-post", "x-filename-id":"document-assignuser-post" } }, "/document/file/{id}/checkin":{ "post":{ "tags":[ "Document" ], "summary":"Check in a File", "description":"Send a request to this endpoint to check in a new version of an existing file.", "operationId":"/document/file/{id}/checkin_checkinDocument", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"Content-Length", "in":"header", "description":"The size of a document in bytes.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"The input stream of an uploaded file.", "content":{ "application/octet-stream":{ "schema":{ "type":"object", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object" } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "text/plain":{ "schema":{ "title":"ApiEntityDocument", "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-file-{id}-checkin-post", "x-filename-id":"document-file-id-checkin-post" } }, "/document/file/{id}/checkout":{ "get":{ "tags":[ "Document" ], "summary":"Check out a File", "description":"Send a request to this endpoint to check out a file. A copy of file will also be downloaded after checkout.
  • To checkout a file which has scan status SCAN_PENDING or SCAN_ERROR or SCAN_INCONCLUSIVE or SCAN_FAILED, send the corresponding scan status or combination of scan statuses (comma separated) in the query parameter.
  • A file which has a scan status SCAN_FAILED can be checked out but the file will not be downloaded.
  • scanStatus query parameter is not required to checkout a file which has scan status SCAN_CLEARED or SCAN_DISABLED
", "operationId":"/document/file/{id}/checkout_checkoutFile", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"scanStatus", "in":"query", "description":"Allowed Values : One or more from [ SCAN_PENDING, SCAN_ERROR, SCAN_INCONCLUSIVE, SCAN_FAILED ] separated by comma.
  • Send this query parameter to checkout the file which has the specified scan status.
  • Example : \"scanStatus=SCAN_PENDING,SCAN_ERROR\". The File will be checked out even if the scan status is SCAN_PENDING or SCAN_ERROR
", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested file does not exist, or you do not have access to it." }, "400":{ "description":"The file is already checked out by another user." }, "204":{ "description":"The file which has a scan status SCAN_FAILED will be checked out but cannot be downloaded." }, "200":{ "description":"Successful operation" } }, "x-internal-id":"document-file-{id}-checkout-get", "x-filename-id":"document-file-id-checkout-get" } }, "/document/templateCopy/sourceTemplate/{id}/targetFolder/{folderId}":{ "post":{ "tags":[ "Document" ], "summary":"Copy a Template to a Folder", "description":"Send a request to this endpoint to copy files and folders of a template to another folder with template ID given as a {id} path parameter and the target folder ID given as a {folderId} path parameter.", "operationId":"/document/templateCopy/sourceTemplate/{id}/targetFolder/{folderId}_copyTemplate", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder template.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"folderId", "in":"path", "description":"The system-generated identifier of a folder.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder or template does not exist, or you do not have access to it." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocument", "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-templateCopy-sourceTemplate-{id}-targetFolder-{folderId}-post", "x-filename-id":"document-templatecopy-sourcetemplate-id-targetfolder-folderid-post" } }, "/document/folder":{ "put":{ "tags":[ "Document" ], "summary":"Update a Folder", "description":"Send a request to this endpoint to update a folder. ", "operationId":"/document/folder_update_20", "requestBody":{ "description":"A folder object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocumentInput", "$ref":"#/components/schemas/ApiEntityDocumentInput", "exampleSetFlag":false }, "examples":{ "Update_a_folder":{ "summary":"Update a folder", "description":"Payload to update a folder using the folder ID, city name, parent folder ID, and comment.", "value":{ "id":122404, "cityName":"Washington DC", "parentId":120401, "comment":"Requires Administration and Executives Approval" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"document-folder-put", "x-filename-id":"document-folder-put" }, "post":{ "tags":[ "Document" ], "summary":"Create a Folder", "description":"Send a request to this endpoint to create a folder.", "operationId":"/document/folder_createFolder", "requestBody":{ "description":"A folder object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocumentInput", "$ref":"#/components/schemas/ApiEntityDocumentInput", "exampleSetFlag":false }, "examples":{ "Create_a_folder":{ "summary":"Create a folder", "description":"Payload to create a folder using workspace ID, name, scope, and parent ID of the folder.", "value":{ "workspaceId":194001, "name":"Master Database", "scope":"program", "parentId":120401 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocument", "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-folder-post", "x-filename-id":"document-folder-post" } }, "/document/file/zip/files":{ "post":{ "tags":[ "Document" ], "summary":"Create Zip for the List of Files under a Scope", "description":"Send a request to this endpoint to create a zip creation request for the specified files under a given scope.", "operationId":"/document/file/zip/files_createZip", "requestBody":{ "description":"Represents the zip request entity.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityZipRequest", "$ref":"#/components/schemas/ApiEntityZipRequest", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityZipRequestDetails", "$ref":"#/components/schemas/ApiEntityZipRequestDetails", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-file-zip-files-post", "x-filename-id":"document-file-zip-files-post" } }, "/document/folder/{id}":{ "get":{ "tags":[ "Document" ], "summary":"View a Folder", "description":"Send a request to this endpoint to view a folder with folder ID given as a {id} path parameter.", "operationId":"/document/folder/{id}_find_23", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocument", "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-folder-{id}-get", "x-filename-id":"document-folder-id-get" }, "delete":{ "tags":[ "Document" ], "summary":"Delete a Folder", "description":"Send a request to this endpoint to delete a folder. The application object with an ID value that matches the value of the {id} path parameter will be deleted.", "operationId":"/document/folder/{id}_delete_21", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"document-folder-{id}-delete", "x-filename-id":"document-folder-id-delete" } }, "/document/batch/folders":{ "delete":{ "tags":[ "Document" ], "summary":"Batch Delete Folders", "description":"Send a request to this endpoint to delete one or more folders. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/document/batch/folders_delete_22", "requestBody":{ "description":"One or more system-generated identifiers of folders.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"document-batch-folders-delete", "x-filename-id":"document-batch-folders-delete" } }, "/document/file/{id}":{ "get":{ "tags":[ "Document" ], "summary":"View a File", "description":"Send a request to the endpoint to view a file with file ID given as a {id} path parameter.", "operationId":"/document/file/{id}_findFile", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested file does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocument", "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-file-{id}-get", "x-filename-id":"document-file-id-get" }, "delete":{ "tags":[ "Document" ], "summary":"Delete a File", "description":"Send a request to this endpoint to delete a file. The application object with an ID value that matches the value of the {id} path parameter will be deleted.", "operationId":"/document/file/{id}_deleteFile", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested file does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"document-file-{id}-delete", "x-filename-id":"document-file-id-delete" } }, "/document/batch/files":{ "delete":{ "tags":[ "Document" ], "summary":"Batch Delete Files", "description":"Send a request to this endpoint to delete one or more files. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/document/batch/files_deleteFiles", "requestBody":{ "description":"One or more system-generated identifiers of files.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"document-batch-files-delete", "x-filename-id":"document-batch-files-delete" } }, "/document/file/{id}/download":{ "get":{ "tags":[ "Document" ], "summary":"Download a File", "description":"Send a request to this endpoint to download the latest version of a file.
  • To download the specific version of a file, send the version number as a value of version query parameter.
  • To download a file which has scan status SCAN_PENDING or SCAN_ERROR or SCAN_INCONCLUSIVE, send the corresponding scan status or combination of scan statuses (comma separated) in the query parameter scanStatus.
  • scanStatus query parameter is not required to download a file which has scan status SCAN_CLEARED or SCAN_DISABLED
", "operationId":"/document/file/{id}/download_downloadFile", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"scanStatus", "in":"query", "description":"Allowed Values : One or more from [ SCAN_PENDING, SCAN_ERROR, SCAN_INCONCLUSIVE ] separated by comma.
  • Send this query parameter to download the file which has the specified scan status.
  • Example : \"scanStatus=SCAN_PENDING,SCAN_ERROR\". The File will be downloaded even if the scan status is SCAN_PENDING or SCAN_ERROR
", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"version", "in":"query", "description":"The version of a file.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested file does not exist, or you do not have access to it." }, "400":{ "description":"The requested file is having scan status SCAN_FAILED or trying to download the file of scanStatus SCAN_PENDING or SCAN_ERROR or SCAN_INCONCLUSIVE without including the scanStatus query parameter." }, "200":{ "description":"Successful operation" } }, "x-internal-id":"document-file-{id}-download-get", "x-filename-id":"document-file-id-download-get" } }, "/document/file/zip/zipRequest/{zipRequestId}":{ "get":{ "tags":[ "Document" ], "summary":"Download the Zip File", "description":"Send a request to this endpoint to download the created zip request provided by the zipRequestId as a path parameter.", "operationId":"/document/file/zip/zipRequest/{zipRequestId}_downloadZip", "parameters":[ { "name":"zipRequestId", "in":"path", "description":"The system-generated identifier of a zip request created.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested zip request detail doesn't exist, or has been deleted, or you do not have access to it." }, "400":{ "description":"The zip request creation is still in progress or it was failed." }, "200":{ "description":"Successful operation" } }, "x-internal-id":"document-file-zip-zipRequest-{zipRequestId}-get", "x-filename-id":"document-file-zip-ziprequest-ziprequestid-get" } }, "/document/folder/{id}/allChildren":{ "get":{ "tags":[ "Document" ], "summary":"View all Files and Folders under a Folder", "description":"Send a request to this endpoint to view all files and child folders that belong to a folder with folder ID given as a {id} path parameter.", "operationId":"/document/folder/{id}/allChildren_findAllChildren", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-folder-{id}-allChildren-get", "x-filename-id":"document-folder-id-allchildren-get" } }, "/document/template/{id}/allChildren":{ "get":{ "tags":[ "Document" ], "summary":"View all Files and Folders under a Template", "description":"Send a request to this endpoint to view all files and folders that belong to a template with template ID given as a {id} path parameter.", "operationId":"/document/template/{id}/allChildren_findAllChildrenByTemplate", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder template.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-template-{id}-allChildren-get", "x-filename-id":"document-template-id-allchildren-get" } }, "/document/folder/{id}/childFolders":{ "get":{ "tags":[ "Document" ], "summary":"View all Folders under a Folder", "description":"Send a request to this endpoint to view all child folders that belong to a folder with folder ID given as a {id} path parameter.", "operationId":"/document/folder/{id}/childFolders_findAllFolders", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-folder-{id}-childFolders-get", "x-filename-id":"document-folder-id-childfolders-get" } }, "/document/template/{id}/childFolders":{ "get":{ "tags":[ "Document" ], "summary":"View all Folders of a Template", "description":"Send a request to this endpoint to view all folders that belong to a template with template ID given as a {id} path parameter.", "operationId":"/document/template/{id}/childFolders_findAllFoldersByTemplate", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder template.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-template-{id}-childFolders-get", "x-filename-id":"document-template-id-childfolders-get" } }, "/document/workspace/{workspaceCode}/{type}/search":{ "get":{ "tags":[ "Document" ], "summary":"View the ID for a File or Folder by Path ", "description":"Send a request to this endpoint to get the ID of a file or folder by it's path from the root folder.", "operationId":"/document/workspace/{workspaceCode}/{type}/search_findByPath", "parameters":[ { "name":"type", "in":"path", "description":"The object name where the file or folder is created.
Allowed Values: [ \"TEMPLATE\", \"PROJECT\", \"GENERIC_PORTFOLIO\", \"IDEA\", \"PROGRAM\", \"STRATEGY\" ]", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"path", "in":"query", "description":"The path of the file or folder from it's root folder.
The field is non-persistable and thus maximum length is not applicable.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested folder or file does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"String", "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-workspace-{workspaceCode}-{type}-search-get", "x-filename-id":"document-workspace-workspacecode-type-search-get" } }, "/document/file/{id}/version/{version}/annotations":{ "get":{ "tags":[ "Document" ], "summary":"View Annotations of a Version of a File", "description":"Send a request to this endpoint to view all annotations of a given version of a file with version number given as a {version} path parameter and file ID given as a {id} path parameter. ", "operationId":"/document/file/{id}/version/{version}/annotations_findFileAnnotations", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"version", "in":"path", "description":"The version of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested file does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAnnotation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-file-{id}-version-{version}-annotations-get", "x-filename-id":"document-file-id-version-version-annotations-get" } }, "/document/file/{id}/version":{ "get":{ "tags":[ "Document" ], "summary":"View all File Versions", "description":"Send a request to this endpoint to view versions of a file with file ID given as a {id} path parameter.", "operationId":"/document/file/{id}/version_findFileVersion", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested file does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFileVersion", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-file-{id}-version-get", "x-filename-id":"document-file-id-version-get" } }, "/document/template/{id}/files":{ "get":{ "tags":[ "Document" ], "summary":"View all Files of a Template", "description":"Send a request to this endpoint to view all files that belong to a template with template ID given as a {id} path parameter.", "operationId":"/document/template/{id}/files_findFilesByTemplate", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder template.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-template-{id}-files-get", "x-filename-id":"document-template-id-files-get" } }, "/document/folder/{id}/files":{ "get":{ "tags":[ "Document" ], "summary":"View all Files of a Folder", "description":"Send a request to this endpoint to view all files that belong to a folder with folder ID given as a {id} path parameter.", "operationId":"/document/folder/{id}/files_findFilesForFolder", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-folder-{id}-files-get", "x-filename-id":"document-folder-id-files-get" } }, "/document/{name}/folderTemplate/{id}":{ "get":{ "tags":[ "Document" ], "summary":"View a Folder by Name and Template", "description":"Send a request to this endpoint to view a folder that belongs to a template with folder name given as a {name} path parameter and template ID given as a {id} path parameter.", "operationId":"/document/{name}/folderTemplate/{id}_findFolderByName", "parameters":[ { "name":"name", "in":"path", "description":"The name of a folder.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"id", "in":"path", "description":"The system-generated identifier of a folder template.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder template does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-{name}-folderTemplate-{id}-get", "x-filename-id":"document-name-foldertemplate-id-get" } }, "/document/portfolio/{portfolioId}/root":{ "get":{ "tags":[ "Document" ], "summary":"View the Root Folder of a Portfolio", "description":"Send a request to this endpoint to view the root folder of a portfolio with portfolio ID given as a {portfolio} path parameter.", "operationId":"/document/portfolio/{portfolioId}/root_findRootFolderByPortfolio", "parameters":[ { "name":"portfolioId", "in":"path", "description":"The system-generated identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocument", "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-portfolio-{portfolioId}-root-get", "x-filename-id":"document-portfolio-portfolioid-root-get" } }, "/document/project/{projectId}/root":{ "get":{ "tags":[ "Document" ], "summary":"View the Root Folder of a Project", "description":"Send a request to this endpoint to view the root folder of a project with project ID given as a {projectId} path parameter.", "operationId":"/document/project/{projectId}/root_findRootFolderByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocument", "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-project-{projectId}-root-get", "x-filename-id":"document-project-projectid-root-get" } }, "/document/template/{id}/root":{ "get":{ "tags":[ "Document" ], "summary":"View the Root Folder of a Template", "description":"Send a request to this endpoint to view the root folder of a folder template with template ID given as a {id} path parameter.", "operationId":"/document/template/{id}/root_findRootFolderByTemplate", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a folder template.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocument", "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-template-{id}-root-get", "x-filename-id":"document-template-id-root-get" } }, "/document/permissionSets":{ "get":{ "tags":[ "Document" ], "summary":"View Available Permission Sets for File", "description":"Send a request to this endpoint to view the available permission sets for the provided file.", "operationId":"/document/permissionSets_getPermissionSets_1", "parameters":[ { "name":"id", "in":"query", "description":"The system-generated identifier of a document.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"scopeId", "in":"query", "description":"The system-generated identifier of the scope where document is created.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"scope", "in":"query", "description":"Scope type where document is created.
Allowed Values: [ \"project\", \"workspace\", \"genericPortfolio\", \"strategy\", \"idea\", \"program\", \"template\"]", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"path", "in":"query", "description":"The path of the file or folder from it's root folder.
The field is non-persistable and thus maximum length is not applicable.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested folder or file does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPermissionSets", "$ref":"#/components/schemas/ApiEntityPermissionSets", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-permissionSets-get", "x-filename-id":"document-permissionsets-get" } }, "/document/{id}/scope/{scope}/scopeId/{scopeId}/linkDocument":{ "get":{ "tags":[ "Document" ], "summary":"Link a File to another Object", "description":"Send a request to this endpoint to link a file to another object.", "operationId":"/document/{id}/scope/{scope}/scopeId/{scopeId}/linkDocument_linkDocument", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"scope", "in":"path", "description":"The object type the file is associated with, for example, workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "project", "pbs", "wbs", "activity", "workPackage", "scopeItem", "scopeItemAssignment", "workflowInstance", "formInstance", "contract", "commitment", "changeOrder", "potentialChangeOrder", "potentialChangeOrderProposal", "paymentApplication", "submittals", "rfi", "changeEvents", "fund", "portfolioFund", "customLogItem", "risk", "programRisk", "constraint", "customLogItemProgram", "programFund", "workManagerTask" ] } }, { "name":"scopeId", "in":"path", "description":"The object ID the file is associated with, for example, The ID of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested file does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"Integer", "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-{id}-scope-{scope}-scopeId-{scopeId}-linkDocument-get", "x-filename-id":"document-id-scope-scope-scopeid-scopeid-linkdocument-get" } }, "/document/file/{id}/references":{ "get":{ "tags":[ "Document" ], "summary":"View all References of a File", "description":"Send a request to this endpoint to view all references of a file with file ID given as a {id} path parameter.", "operationId":"/document/file/{id}/references_loadReference", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested file does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReference", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-file-{id}-references-get", "x-filename-id":"document-file-id-references-get" } }, "/document/file/rescan/batch":{ "post":{ "tags":[ "Document" ], "summary":"Batch Rescan Files", "description":"Send a request to this endpoint to rescan one or more files. Only the files with scanStatus as SCAN_ERROR can be rescanned.", "operationId":"/document/file/rescan/batch_rescanBatch", "requestBody":{ "description":"The files to be rescanned", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRescanRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Rescan_files":{ "summary":"Batch Rescan Files", "description":"Payload to rescan files using the file ID.", "value":[ { "id":122411 }, { "id":122408 } ], "valueSetFlag":true } }, "exampleSetFlag":false } } }, "responses":{ "207":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRescanResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-file-rescan-batch-post", "x-filename-id":"document-file-rescan-batch-post" } }, "/document/file/rescan":{ "post":{ "tags":[ "Document" ], "summary":"Rescan a File", "description":"Send a request to this endpoint to rescan a file. Only the files with scanStatus as SCAN_ERROR can be rescanned.", "operationId":"/document/file/rescan_rescanDocument", "requestBody":{ "description":"The file to be rescanned", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRescanRequest", "$ref":"#/components/schemas/ApiEntityRescanRequest", "exampleSetFlag":false }, "examples":{ "Rescan_a_file":{ "summary":"Rescan a file", "description":"Payload to rescan a file using the file ID.", "value":{ "id":122405 }, "valueSetFlag":true } }, "exampleSetFlag":false } } }, "responses":{ "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRescanResponse", "$ref":"#/components/schemas/ApiEntityRescanResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-file-rescan-post", "x-filename-id":"document-file-rescan-post" } }, "/document/{id}/scope/{scope}/scopeId/{scopeId}/unlinkDocument":{ "get":{ "tags":[ "Document" ], "summary":"Unlink a File", "description":"Send a request to this endpoint to unlink a file.", "operationId":"/document/{id}/scope/{scope}/scopeId/{scopeId}/unlinkDocument_unlinkDocument", "parameters":[ { "name":"id", "in":"path", "description":"The system-generated identifier of a file.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"scope", "in":"path", "description":"The object type the file is associated with, for example, workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "project", "pbs", "wbs", "activity", "workPackage", "scopeItem", "scopeItemAssignment", "workflowInstance", "formInstance", "contract", "commitment", "changeOrder", "potentialChangeOrder", "potentialChangeOrderProposal", "paymentApplication", "submittals", "rfi", "changeEvents", "fund", "portfolioFund", "customLogItem", "risk", "programRisk", "constraint", "customLogItemProgram", "programFund", "workManagerTask" ] } }, { "name":"scopeId", "in":"path", "description":"The object ID the file is associated with, for example, The ID of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested file does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"Integer", "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"document-{id}-scope-{scope}-scopeId-{scopeId}-unlinkDocument-get", "x-filename-id":"document-id-scope-scope-scopeid-scopeid-unlinkdocument-get" } }, "/document/file":{ "put":{ "tags":[ "Document" ], "summary":"Update a File", "description":"Send a request to this endpoint to update a file.", "operationId":"/document/file_updateFile", "requestBody":{ "description":"A file object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocumentInput", "$ref":"#/components/schemas/ApiEntityDocumentInput", "exampleSetFlag":false }, "examples":{ "Update_a_File_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a File by Assigning Multiple Code Values Using IDs", "description":"Payload to update a file using the parent folder path, name, scope, workspace ID, and codeValuesDocument fields such as code value ID and code type ID.", "value":{ "parentFolderPath":"Program1", "name":"ImportLog.JPG", "scope":"program", "workspaceId":1098902, "codeValuesDocument":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Update_a_File_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a File by Assigning Code Values Using Codes", "description":"Payload to update a file using the parent folder path, name, scope, workspace ID, and codeValuesDocument fields such as code value code and code type code.", "value":{ "parentFolderPath":"Program1", "name":"ImportLog.JPG", "scope":"program", "workspaceId":1098902, "codeValuesDocument":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_File_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a File by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update a file using the parent folder path, name, scope, workspace ID, and codeValuesDocument fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "parentFolderPath":"Program1", "name":"ImportLog.JPG", "scope":"program", "workspaceId":1098902, "codeValuesDocument":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Update_a_File_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Update a File that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to update a file using the parent folder path, name, scope, workspace ID, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "parentFolderPath":"Program1", "name":"ImportLog.JPG", "scope":"program", "workspaceId":1098902, "documentConfiguredFields":[ { "columnName":"Notes", "textValue":"File attached" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Update_a_File_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a File by Assigning Code Values Using IDs", "description":"Payload to update a file using the parent folder path, name, scope, workspace ID, and codeValuesDocument fields such as code value ID and code type ID.", "value":{ "parentFolderPath":"Program1", "name":"ImportLog.JPG", "scope":"program", "workspaceId":1098902, "codeValuesDocument":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_file":{ "summary":"Update a file", "description":"Payload to update a file using the file ID, city name, and comment.", "value":{ "id":122411, "cityName":"Washington DC", "comment":"Requires Administration Approval" }, "valueSetFlag":true }, "Update_a_File_that_include_Configured_Field_Text":{ "summary":"Update a File that include Configured Field Text", "description":"Payload to update a file using the parent folder path, name, scope, workspace ID, and values for the configured field which include column name, column definition ID, text value.", "value":{ "parentFolderPath":"Program1", "name":"ImportLog.JPG", "scope":"program", "workspaceId":1098902, "documentConfiguredFields":[ { "columnName":"Notes", "textValue":"File attached" }, { "columnDefinationId":60045, "textValue":"N" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"document-file-put", "x-filename-id":"document-file-put" } }, "/document/uploadFile/parent/{folderId}/fileName/{fileName}":{ "post":{ "tags":[ "Document" ], "summary":"Upload a File", "description":"Send a request to this endpoint to upload a new file.", "operationId":"/document/uploadFile/parent/{folderId}/fileName/{fileName}_uploadNewFileWithHeader", "parameters":[ { "name":"folderId", "in":"path", "description":"The system-generated identifier of a folder.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"Content-Length", "in":"header", "description":"The size of a document in bytes.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"fileName", "in":"path", "description":"The name of a file.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "requestBody":{ "description":"The input stream of an uploaded file.", "content":{ "application/octet-stream":{ "schema":{ "type":"object", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object" } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "404":{ "description":"The requested folder does not exist, or you do not have access to it." }, "400":{ "description":"Invalid input for the Document service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocument", "$ref":"#/components/schemas/ApiEntityDocument", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-uploadFile-parent-{folderId}-fileName-{fileName}-post", "x-filename-id":"document-uploadfile-parent-folderid-filename-filename-post" } }, "/document/file/zip/status/zipRequest/{zipRequestId}":{ "get":{ "tags":[ "Document" ], "summary":"View the Zip Request Details by Zip Request ID", "description":"Send a request to this endpoint to view the current status of the zip request provided by the zipRequestId as a path parameter.", "operationId":"/document/file/zip/status/zipRequest/{zipRequestId}_viewZipRequestDetails", "parameters":[ { "name":"zipRequestId", "in":"path", "description":"The system-generated identifier of a zip request created.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested zip request detail doesn't exist, or has been deleted, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityZipRequestDetails", "$ref":"#/components/schemas/ApiEntityZipRequestDetails", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"document-file-zip-status-zipRequest-{zipRequestId}-get", "x-filename-id":"document-file-zip-status-ziprequest-ziprequestid-get" } }, "/folderTemplate":{ "put":{ "tags":[ "Document Folder Structure Template" ], "summary":"Update a Document Folder Structure Template", "description":"Send a request to this endpoint to update a document folder structure template. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/folderTemplate_update_21", "requestBody":{ "description":"A folder template object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocumentFolderStructureTemplateInput", "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplateInput", "exampleSetFlag":false }, "examples":{ "Update_a_Document_Folder_Structure_Template":{ "summary":"Update a Document Folder Structure Template", "description":"Payload to update a document folder structure template using the document folder structure template ID, workspace ID, template name, and push down type, such as manual or automatic.", "value":{ "documentFolderStructureTemplateId":26001, "templateName":"Utility Document", "workspaceId":10001, "pushDownType":"AUTOMATIC" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document Folder Structure Template service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"folderTemplate-put", "x-filename-id":"foldertemplate-put" }, "post":{ "tags":[ "Document Folder Structure Template" ], "summary":"Create a Document Folder Structure Template", "description":"Send a request to this endpoint to create a document folder structure template. An application object will be created using the JSON data provided in the request body.", "operationId":"/folderTemplate_create_21", "requestBody":{ "description":"A folder template object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocumentFolderStructureTemplateInput", "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplateInput", "exampleSetFlag":false }, "examples":{ "Create_a_Document_Folder_Structure_Template":{ "summary":"Create a Document Folder Structure Template", "description":"Payload to create a document folder structure template using the workspace ID, template name, and push down type, such as manual or automatic.", "value":{ "templateName":"Utility Document", "workspaceId":10001, "pushDownType":"MANUAL" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document Folder Structure Template service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocumentFolderStructureTemplate", "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplate", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"folderTemplate-post", "x-filename-id":"foldertemplate-post" } }, "/folderTemplate/batch":{ "put":{ "tags":[ "Document Folder Structure Template" ], "summary":"Batch Update Document Folder Structure Templates", "description":"Send a request to this endpoint to update one or more document folder structure templates. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/folderTemplate/batch_updateBatch_18", "requestBody":{ "description":"One or more folder template objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Document_Folder_Structure_Templates":{ "summary":"Batch Update Document Folder Structure Templates", "description":"Payload to update one or more document folder structure templates using the document folder structure template ID, workspace ID, template name and push down type, such as manual or automatic.", "value":[ { "documentFolderStructureTemplateId":26002, "templateName":"Reimbursement Document", "workspaceId":10001, "pushDownType":"MANUAL" }, { "documentFolderStructureTemplateId":26003, "templateName":"Registration Document", "workspaceId":10001, "pushDownType":"AUTOMATIC" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document Folder Structure Template service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"folderTemplate-batch-put", "x-filename-id":"foldertemplate-batch-put" }, "post":{ "tags":[ "Document Folder Structure Template" ], "summary":"Batch Create Document Folder Structure Templates", "description":"Send a request to this endpoint to create one or more document folder structure templates. An application object will be created for each JSON object provided in the request body.", "operationId":"/folderTemplate/batch_createBatch_20", "requestBody":{ "description":"One or more folder template objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Document_Folder_Structure_Templates":{ "summary":"Batch Create Document Folder Structure Templates", "description":"Payload to create one or more document folder structure templates using the workspace ID, template name, and push down type, such as manual or automatic.", "value":[ { "templateName":"Reimbursement Document", "workspaceId":10001, "pushDownType":"AUTOMATIC" }, { "templateName":"Registration Document", "workspaceId":10001, "pushDownType":"MANUAL" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document Folder Structure Template service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"folderTemplate-batch-post", "x-filename-id":"foldertemplate-batch-post" }, "delete":{ "tags":[ "Document Folder Structure Template" ], "summary":"Batch Delete Document Folder Structure Templates", "description":"Send a request to this endpoint to delete one or more document folder structure templates. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/folderTemplate/batch_deleteBatch_20", "requestBody":{ "description":"The system-generated identifier of a folder template.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "404":{ "description":"The requested document folder structure template does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"folderTemplate-batch-delete", "x-filename-id":"foldertemplate-batch-delete" } }, "/folderTemplate/{documentFolderStructureTemplateId}":{ "get":{ "tags":[ "Document Folder Structure Template" ], "summary":"View a Document Folder Structure Template", "description":"This endpoint returns document folder structure templates that meet the following requirements:
  • The object has an ID that matches the value of the {documentFolderStructureTemplateId} path parameter.
", "operationId":"/folderTemplate/{documentFolderStructureTemplateId}_find_24", "parameters":[ { "name":"documentFolderStructureTemplateId", "in":"path", "description":"The system-generated identifier of a folder template.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested document folder structure template does not exist, or you do not have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityDocumentFolderStructureTemplate", "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplate", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"folderTemplate-{documentFolderStructureTemplateId}-get", "x-filename-id":"foldertemplate-documentfolderstructuretemplateid-get" }, "delete":{ "tags":[ "Document Folder Structure Template" ], "summary":"Delete a Document Folder Structure Template", "description":"Send a request to this endpoint to delete a document folder structure template. The application object with an ID value that matches the value of the {documentFolderStructureTemplateId} path parameter will be deleted.", "operationId":"/folderTemplate/{documentFolderStructureTemplateId}_delete_23", "parameters":[ { "name":"documentFolderStructureTemplateId", "in":"path", "description":"The system-generated identifier of a folder template.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested document folder structure template does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"folderTemplate-{documentFolderStructureTemplateId}-delete", "x-filename-id":"foldertemplate-documentfolderstructuretemplateid-delete" } }, "/folderTemplate/workspace/{workspaceId}":{ "get":{ "tags":[ "Document Folder Structure Template" ], "summary":"View all Document Folder Structure Templates by Workspace", "description":"This endpoint returns document folder structure templates that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/folderTemplate/workspace/{workspaceId}_findAllTemplates", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested document folder structure template does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"folderTemplate-workspace-{workspaceId}-get", "x-filename-id":"foldertemplate-workspace-workspaceid-get" } }, "/folderTemplate/name/{templateName}":{ "get":{ "tags":[ "Document Folder Structure Template" ], "summary":"View Document Folder Structure Templates by Name", "description":"This endpoint returns document folder structure templates that meet the following requirements:
  • The object has a name that matches the value of the {templateName} path parameter.
", "operationId":"/folderTemplate/name/{templateName}_findByName_5", "parameters":[ { "name":"templateName", "in":"path", "description":"The name of a folder template.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested document folder structure template does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"folderTemplate-name-{templateName}-get", "x-filename-id":"foldertemplate-name-templatename-get" } }, "/folderTemplate/syncBatch":{ "post":{ "tags":[ "Document Folder Structure Template" ], "summary":"Batch Sync Document Folder Structure Templates", "description":"Send a request to this endpoint to create or update one or more document folder structure templates.", "operationId":"/folderTemplate/syncBatch_syncBatch_20", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any document folder structure template sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more folder template objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocumentFolderStructureTemplateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Document_Folder_Structure_Template_Using_Workspace_ID":{ "summary":"Create or Update a Document Folder Structure Template Using Workspace ID", "description":"Payload to create or update a document folder structure template using the workspace ID, template name, and push down type which can be manual or automatic.", "value":[ { "templateName":"Utility Document", "workspaceId":10001, "pushDownType":"MANUAL" } ], "valueSetFlag":true }, "Create_or_Update_a_Document_Folder_Structure_Template_Using_Workspace_Code":{ "summary":"Create or Update a Document Folder Structure Template Using Workspace Code", "description":"Payload to create or update a document folder structure template using the workspace code, template name, and push down type which can be manual or automatic.", "value":[ { "templateName":"Utility Document", "workspaceCode":"North America", "pushDownType":"MANUAL" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Document Folder Structure Template service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"folderTemplate-syncBatch-post", "x-filename-id":"foldertemplate-syncbatch-post" } }, "/evaluationMatrix/workspace/{workspaceId}":{ "get":{ "tags":[ "Evaluation Categories" ], "summary":"View Evaluation Matrix by Workspace", "description":"This endpoint returns evaluation Matrix that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/evaluationMatrix/workspace/{workspaceId}_findByWorkspace_1", "parameters":[ { "name":"workspaceId", "in":"path", "description":"ID of the workspace for which Evaluation Matrix has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityEvaluationMatrix", "$ref":"#/components/schemas/ApiEntityEvaluationMatrix", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "204":{ "description":"Successful operation with no content." }, "404":{ "description":"The requested evaluation matrix does not exist, or you do not have access to them." } }, "x-internal-id":"evaluationMatrix-workspace-{workspaceId}-get", "x-filename-id":"evaluationmatrix-workspace-workspaceid-get" } }, "/evaluationMatrix/evaluationRank":{ "put":{ "tags":[ "Evaluation Categories" ], "summary":"Update an Evaluation Rank", "description":"Send a request to this endpoint to update an evaluation Rank. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/evaluationMatrix/evaluationRank_updateEvaluationRank", "requestBody":{ "description":"Evaluation Rank to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityEvaluationRankInput", "$ref":"#/components/schemas/ApiEntityEvaluationRankInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Evaluation Category service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"evaluationMatrix-evaluationRank-put", "x-filename-id":"evaluationmatrix-evaluationrank-put" } }, "/exchangeRate":{ "post":{ "tags":[ "Exchange Rate" ], "summary":"Create an Exchange Rate", "description":"Send a request to this endpoint to create an exchange rate. An application object will be created using the JSON data provided in the request body.", "operationId":"/exchangeRate_create_22", "requestBody":{ "description":"ExchangeRate to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExchangeRateInput", "$ref":"#/components/schemas/ApiEntityExchangeRateInput", "exampleSetFlag":false }, "examples":{ "Create_an_Exchange_Rate":{ "summary":"Create an Exchange Rate", "description":"Payload to create the exchange rate using the effective start date, base exchange rate, currency code, and workspace code.", "value":{ "effectiveStartDate":"2023-03-10T01:43:39", "baseExchangeRate":80.67, "workspaceCode":"Ananth Constructions", "currencyCode":"IDR" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Exchange Rate service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExchangeRate", "$ref":"#/components/schemas/ApiEntityExchangeRate", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"exchangeRate-post", "x-filename-id":"exchangerate-post" } }, "/exchangeRate/{exchangeRateId}":{ "get":{ "tags":[ "Exchange Rate" ], "summary":"View an Exchange Rate ", "description":"This endpoint returns an exchange rate. that meet the following requirements:
  • The object has an ID that matches the value of the {exchangeRateId} path parameter.
", "operationId":"/exchangeRate/{exchangeRateId}_find_25", "parameters":[ { "name":"exchangeRateId", "in":"path", "description":"ID of the exchangeRate to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested exchange rate does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExchangeRate", "$ref":"#/components/schemas/ApiEntityExchangeRate", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"exchangeRate-{exchangeRateId}-get", "x-filename-id":"exchangerate-exchangerateid-get" } }, "/exchangeRate/currency/{currencyId}":{ "get":{ "tags":[ "Exchange Rate" ], "summary":"View Exchange Rates by Currency ", "description":"This endpoint returns exchange rates that meet the following requirements:
  • The object is associated with a currency with an ID value that matches the value of the {currencyId} path parameter.
", "operationId":"/exchangeRate/currency/{currencyId}_findByCurrencyId", "parameters":[ { "name":"currencyId", "in":"path", "description":"ID of the currency whose exchange rates are to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested exchange rates do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExchangeRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"exchangeRate-currency-{currencyId}-get", "x-filename-id":"exchangerate-currency-currencyid-get" } }, "/fundActual":{ "put":{ "tags":[ "Fund Actual" ], "summary":"Update an Fund Actual", "description":"Send a request to this endpoint to update an fund actual. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/fundActual_update_22", "requestBody":{ "description":"A fund actual object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundActualInput", "$ref":"#/components/schemas/ApiEntityFundActualInput", "exampleSetFlag":false }, "examples":{ "Update_a_Fund_Actual_Using_Fund_Actual_ID":{ "summary":"Update a Fund Actual Using Fund Actual ID", "description":"Payload to update the fund actual cost using the fund actual ID.", "value":{ "fundActualId":4, "fundActualCost":{ "assignedCostProject":150000 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Fund Actual service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"fundActual-put", "x-filename-id":"fundactual-put" }, "post":{ "tags":[ "Fund Actual" ], "summary":"Create an Fund Actual", "description":"Send a request to this endpoint to create an fund actual. An application object will be created using the JSON data provided in the request body.", "operationId":"/fundActual_create_23", "requestBody":{ "description":"A fund actual object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundActualInput", "$ref":"#/components/schemas/ApiEntityFundActualInput", "exampleSetFlag":false }, "examples":{ "Create_a_Fund_Actual":{ "summary":"Create a Fund Actual", "description":"Payload to create a fund actual using the project actuals ID, fund actual cost, fund code, project code, and workspace code.", "value":{ "projectActualsId":1, "fundActualCost":{ "assignedCostProject":100000 }, "fundCode":"Municipal Funds", "projectCode":"Airport Construction", "workspaceCode":"Bangalore" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Fund Actual service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundActual", "$ref":"#/components/schemas/ApiEntityFundActual", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"fundActual-post", "x-filename-id":"fundactual-post" } }, "/fundActual/batch":{ "put":{ "tags":[ "Fund Actual" ], "summary":"Batch Update Fund Actuals", "description":"Send a request to this endpoint to update one or more fund actuals. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/fundActual/batch_updateBatch_19", "requestBody":{ "description":"One or more fund actual objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundActualInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_a_Fund_Actual_Using_Fund_Actual_IDs":{ "summary":"Batch Update Fund Actuals Using Fund actual IDs", "description":"Payload to update the fund actual cost of one or more fund actuals using the fund actual IDs.", "value":[ { "fundActualId":4, "fundActualCost":{ "assignedCostProject":150000 } }, { "fundActualId":5, "fundActualCost":{ "assignedCostProject":250000 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Fund Actual service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"fundActual-batch-put", "x-filename-id":"fundactual-batch-put" }, "post":{ "tags":[ "Fund Actual" ], "summary":"Batch Create Fund Actuals", "description":"Send a request to this endpoint to create one or more fund actuals. An application object will be created for each JSON object provided in the request body. ", "operationId":"/fundActual/batch_createBatch_21", "requestBody":{ "description":"One or more fund actual objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundActualInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Fund_Actuals":{ "summary":"Batch Create Fund Actuals", "description":"Payload to create one or more fund actuals using the project actuals IDs, fund actual costs, fund codes, project codes, and workspace codes.", "value":[ { "projectActualsId":1, "fundActualCost":{ "assignedCostProject":100000 }, "fundCode":"Municipal Funds", "projectCode":"Airport Construction", "workspaceCode":"Bangalore" }, { "projectActualsId":1, "fundActualCost":{ "assignedCostProject":500000 }, "fundCode":"Government Grants", "projectCode":"Airport Construction", "workspaceCode":"Bangalore" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Fund Actual service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundActual", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"fundActual-batch-post", "x-filename-id":"fundactual-batch-post" }, "delete":{ "tags":[ "Fund Actual" ], "summary":"Batch Delete Fund Actuals", "description":"Send a request to this endpoint to delete one or more fund actuals. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/fundActual/batch_deleteBatch_21", "requestBody":{ "description":"The system-generated identifier of a fund actual.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"fundActual-batch-delete", "x-filename-id":"fundactual-batch-delete" } }, "/fundActual/{fundActualId}":{ "get":{ "tags":[ "Fund Actual" ], "summary":"View an Fund Actual", "description":"This endpoint returns fund actuals that meet the following requirements:
  • The object is associated with a fund actual with an ID value that matches the value of the {fundActualId} path parameter.
Fund Actuals represent the funds allocated to Project Actuals.", "operationId":"/fundActual/{fundActualId}_find_26", "parameters":[ { "name":"fundActualId", "in":"path", "description":"The system-generated identifier of a fund actual.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested fund actual does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundActual", "$ref":"#/components/schemas/ApiEntityFundActual", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"fundActual-{fundActualId}-get", "x-filename-id":"fundactual-fundactualid-get" }, "delete":{ "tags":[ "Fund Actual" ], "summary":"Delete an Fund Actual", "description":"Send a request to this endpoint to delete an fund actual. The application object with an ID value that matches the value of the {fundActualId} path parameter will be deleted.", "operationId":"/fundActual/{fundActualId}_delete_24", "parameters":[ { "name":"fundActualId", "in":"path", "description":"The system-generated identifier of a fund actual.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"fundActual-{fundActualId}-delete", "x-filename-id":"fundactual-fundactualid-delete" } }, "/fundActual/projectActuals/{projectActualsId}":{ "get":{ "tags":[ "Fund Actual" ], "summary":"View an Fund Actual by Project Actual", "description":"Send a request to this endpoint to view all allocated funds to a project actual.", "operationId":"/fundActual/projectActuals/{projectActualsId}_getByProjectActuals", "parameters":[ { "name":"projectActualsId", "in":"path", "description":"The system-generated identifier for the project actual.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested fund actual does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundActual", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"fundActual-projectActuals-{projectActualsId}-get", "x-filename-id":"fundactual-projectactuals-projectactualsid-get" } }, "/fundActual/syncBatch":{ "post":{ "tags":[ "Fund Actual" ], "summary":"Batch Sync Fund Actuals", "description":"Send a request to this endpoint to create or update one or more fund actuals.", "operationId":"/fundActual/syncBatch_syncBatch_21", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any fund actual sent as part of the request.
Allowed Values: [ \"true\", \"false\" ].", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more fund actual objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundActualInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Fund_Actuals_Using_Fund_Actual_Cost":{ "summary":"Create or Update a Fund Actuals Using Fund Actual Cost", "description":"Payload to create or update a fund actual using the project actuals ID, fund actual cost, fund code, project code, and workspace code.", "value":[ { "projectActualsId":1, "fundActualCost":{ "assignedCostProject":100000 }, "fundCode":"Municipal Funds", "projectCode":"Airport Construction", "workspaceCode":"Bangalore" } ], "valueSetFlag":true }, "Create_or_Update_a_Fund_Actuals":{ "summary":"Create or Update a Fund Actuals", "description":"Payload to create or update a fund actual using the project actuals ID, fund code, project code, and workspace code.", "value":[ { "projectActualsId":1, "fundCode":"Municipal Funds", "projectCode":"Airport Construction", "workspaceCode":"Bangalore" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Fund Actual service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"fundActual-syncBatch-post", "x-filename-id":"fundactual-syncbatch-post" } }, "/globalPermissions/assignUser":{ "post":{ "tags":[ "Global Permissions" ], "summary":"Assign Permission Profiles", "description":"Use this endpoint to assign global permission profiles to one or more users.", "operationId":"/globalPermissions/assignUser_assignUser_2", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when validating any user permission profile sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with global permissions and user profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityGlobalUserPermissions", "$ref":"#/components/schemas/ApiEntityGlobalUserPermissions", "exampleSetFlag":false }, "examples":{ "Assign_Global_permissions_To_User_Using_IDs":{ "summary":"Assign Global Permissions To User Using IDs", "description":"Payload to assign global permission to user using global profile Id, and user name.", "value":{ "profiles":[ { "userName":"Adams@example.com", "globalProfileId":"10101" }, { "userName":"Baker@example.com", "globalProfileId":"11" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the global permission service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityGlobalUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityGlobalUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"globalPermissions-assignUser-post", "x-filename-id":"globalpermissions-assignuser-post" } }, "/globalPermissions/permissionSets":{ "get":{ "tags":[ "Global Permissions" ], "summary":"View Available Global Permission Sets", "description":"Send a request to this endpoint to view the global permission sets.", "operationId":"/globalPermissions/permissionSets_getPermissionSets_2", "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPermissionSets", "$ref":"#/components/schemas/ApiEntityPermissionSets", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"globalPermissions-permissionSets-get", "x-filename-id":"globalpermissions-permissionsets-get" } }, "/holiday/{holidayId}":{ "delete":{ "tags":[ "Holiday" ], "summary":"Delete a Holiday", "description":"Send a request to this endpoint to delete a holiday. The application object with an ID value that matches the value of the {holidayId} path parameter will be deleted.", "operationId":"/holiday/{holidayId}_delete_25", "parameters":[ { "name":"holidayId", "in":"path", "description":"ID of the Holiday to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Holiday service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"holiday-{holidayId}-delete", "x-filename-id":"holiday-holidayid-delete" } }, "/holiday/batch":{ "delete":{ "tags":[ "Holiday" ], "summary":"Batch Delete Holidays", "description":"Send a request to this endpoint to delete one or more holidays. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/holiday/batch_deleteBatch_22", "requestBody":{ "description":"IDs of the Holiday to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Holiday service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"holiday-batch-delete", "x-filename-id":"holiday-batch-delete" } }, "/holidayList":{ "put":{ "tags":[ "Holiday List" ], "summary":"Update a Holiday List ", "description":"Send a request to this endpoint to update a holiday list. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/holidayList_update_23", "requestBody":{ "description":"Holiday List to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityHolidayGroupInput", "$ref":"#/components/schemas/ApiEntityHolidayGroupInput", "exampleSetFlag":false }, "examples":{ "Update_a_Holiday_List_Using_Holiday_List_ID":{ "summary":"Update a Holiday List Using Holiday List ID", "description":"Payload to update name of a holiday list using holiday list ID.", "value":{ "holidayGroupName":"2023 Organization Holidays", "holidayListId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"holidayList-put", "x-filename-id":"holidaylist-put" }, "post":{ "tags":[ "Holiday List" ], "summary":"Create a Holiday List", "description":"Send a request to this endpoint to create a holiday list. An application object will be created using the JSON data provided in the request body.", "operationId":"/holidayList_create_24", "requestBody":{ "description":"Holiday List to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityHolidayGroupInput", "$ref":"#/components/schemas/ApiEntityHolidayGroupInput", "exampleSetFlag":false }, "examples":{ "Create_a_Holiday_List":{ "summary":"Create a Holiday List", "description":"Payload to create a holiday list using workspace ID, and holiday group name.", "value":{ "holidayGroupName":"Organization Yearly Holidays", "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityHolidayGroup", "$ref":"#/components/schemas/ApiEntityHolidayGroup", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"holidayList-post", "x-filename-id":"holidaylist-post" } }, "/holidayList/batch":{ "put":{ "tags":[ "Holiday List" ], "summary":"Batch Update Holiday Lists", "description":"Send a request to this endpoint to update one or more holiday lists. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/holidayList/batch_updateBatch_20", "requestBody":{ "description":"Holiday Lists to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityHolidayGroupInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Holiday_Lists_Using_Holiday_List_IDs":{ "summary":"Batch Update Holiday Lists Using Holiday List IDs", "description":"Payload to update name of one or more holiday lists using holiday list IDs.", "value":[ { "holidayGroupName":"Organization Holidays", "holidayListId":10001 }, { "holidayGroupName":"Global Holidays", "holidayListId":10002 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"holidayList-batch-put", "x-filename-id":"holidaylist-batch-put" }, "post":{ "tags":[ "Holiday List" ], "summary":"Batch Create Holiday Lists", "description":"Send a request to this endpoint to create one or more holiday lists. An application object will be created for each JSON object provided in the request body.", "operationId":"/holidayList/batch_createBatch_22", "requestBody":{ "description":"Search and retrieve Holiday Lists.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityHolidayGroupInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Holiday_Lists":{ "summary":"Batch Create Holiday Lists", "description":"Payload to create one or more holiday lists using workspace ID, and holiday group name.", "value":[ { "holidayGroupName":"Organization Holidays", "workspaceId":10001 }, { "holidayGroupName":"Global Holidays", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityHolidayGroup", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"holidayList-batch-post", "x-filename-id":"holidaylist-batch-post" }, "delete":{ "tags":[ "Holiday List" ], "summary":"Batch Delete Holiday Lists ", "description":"Send a request to this endpoint to delete one or more holiday lists. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/holidayList/batch_deleteBatch_23", "requestBody":{ "description":"IDs of the Holiday Lists to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"holidayList-batch-delete", "x-filename-id":"holidaylist-batch-delete" } }, "/holidayList/{holidayListId}":{ "get":{ "tags":[ "Holiday List" ], "summary":"View a Holiday List ", "description":"This endpoint returns holiday lists that meet the following requirements:
  • The object has an ID that matches the value of the {holidayListId} path parameter.
", "operationId":"/holidayList/{holidayListId}_find_27", "parameters":[ { "name":"holidayListId", "in":"path", "description":"ID of the Holiday List to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested holiday list does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityHolidayGroup", "$ref":"#/components/schemas/ApiEntityHolidayGroup", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"holidayList-{holidayListId}-get", "x-filename-id":"holidaylist-holidaylistid-get" }, "delete":{ "tags":[ "Holiday List" ], "summary":"Delete a Holiday List ", "description":"Send a request to this endpoint to delete a holiday list. The application object with an ID value that matches the value of the {holidayListId} path parameter will be deleted.", "operationId":"/holidayList/{holidayListId}_delete_26", "parameters":[ { "name":"holidayListId", "in":"path", "description":"ID of the Holiday List to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"holidayList-{holidayListId}-delete", "x-filename-id":"holidaylist-holidaylistid-delete" } }, "/holidayList/name/{holidayGroupName}":{ "get":{ "tags":[ "Holiday List" ], "summary":"View a Holiday List by Name ", "description":"This endpoint returns holiday lists that meet the following requirements:
  • The object has a name that matches the value of the {holidayGroupName} path parameter.
", "operationId":"/holidayList/name/{holidayGroupName}_findByName_6", "parameters":[ { "name":"holidayGroupName", "in":"path", "description":"Name of the holiday List to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested holiday list does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityHolidayGroup", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"holidayList-name-{holidayGroupName}-get", "x-filename-id":"holidaylist-name-holidaygroupname-get" } }, "/holidayList/syncBatch":{ "post":{ "tags":[ "Holiday List" ], "summary":"Batch Sync Holiday Lists", "description":"Send a request to this endpoint to create or update one or more holiday lists.", "operationId":"/holidayList/syncBatch_syncBatch_22", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any holiday list sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"Search and retrieve Holiday Lists.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityHolidayGroupInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Holiday_Lists":{ "summary":"Create or Update Holiday Lists", "description":"Payload to create or update a holiday list using the workspace ID and holiday group name.", "value":[ { "holidayGroupName":"Organisation Yearly Holidays", "workspaceId":10001 } ], "valueSetFlag":true }, "Create_or_Update_Holiday_Lists_Using_Holiday_Name_and_Holiday_Date":{ "summary":"Create or Update Holiday Lists Using Holiday Name and Holiday Date", "description":"Payload to create or update a holiday list using the workspace ID, holiday group name, holiday name, and holiday date.", "value":[ { "workspaceId":22002, "holidays":[ { "holidayName":"Good Friday", "holidayDate":"2023-03-07T00:00:00" } ], "holidayGroupName":"Organisation Yearly Holidays" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Holiday List service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"holidayList-syncBatch-post", "x-filename-id":"holidaylist-syncbatch-post" } }, "/idea/assignUser":{ "post":{ "tags":[ "Idea" ], "summary":"Assign Permission Profiles To User", "description":"Send a request to this endpoint to view the user's permission sets for the provided idea.", "operationId":"/idea/assignUser_assignUser_3", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail to successfully complete the request if an error occurred when validating any user permission profile sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with idea and user profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityIdeaUserPermissions", "$ref":"#/components/schemas/ApiEntityIdeaUserPermissions", "exampleSetFlag":false }, "examples":{ "Assign_Idea_Permission_Profiles_to_Multiple_Users_Using_Codes":{ "summary":"Assign Idea Permission Profiles to Multiple Users Using Codes", "description":"Payload to assign idea permission to multiple users using idea name, workspace ID, profiles such as user name, idea profile ID, and file profile ID.", "value":{ "ideaName":"Human Resource Planning", "workspaceId":1098902, "profiles":[ { "userName":"manager@example.com", "ideaProfileId":"8", "fileProfileId":"6" }, { "userName":"supervisor@example.com", "ideaProfileId":"8", "fileProfileId":"6" } ] }, "valueSetFlag":true }, "Assign_Idea_Permission_Profiles_to_Multiple_Users_Using_IDs":{ "summary":"Assign Idea Permission Profiles to Multiple Users Using IDs", "description":"Payload to assign idea permission to multiple users using mandatory fields such as idea ID, user name, and idea profile ID.", "value":{ "ideaId":348001, "profiles":[ { "userName":"manager@example.com", "ideaProfileId":"8" }, { "userName":"supervisor@example.com", "ideaProfileId":"8" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the idea service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityIdeaUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityIdeaUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-assignUser-post", "x-filename-id":"idea-assignuser-post" } }, "/idea":{ "put":{ "tags":[ "Idea" ], "summary":"Update an Idea", "description":"Update an idea with the json objects provided.", "operationId":"/idea_update_24", "requestBody":{ "description":"An idea object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityIdeaInput", "$ref":"#/components/schemas/ApiEntityIdeaInput", "exampleSetFlag":false }, "examples":{ "Update_an_Idea_by_Removing_a_Configured_Field":{ "summary":"Update an Idea by Removing a Configured Field", "description":"Payload to update an idea using the idea ID and specifying the action and column label for the configured field to be removed.", "value":{ "ideaId":4005, "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true }, "Update_an_Idea_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update an Idea by Assigning Code Values Using Codes", "description":"Payload to update an idea using the idea name, idea ID, workspace code, and codeValuesIdea fields such as code value code and code type code.", "value":{ "ideaName":"Human Resource Planning", "workspaceCode":"Asia", "codeValuesIdea":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_an_Idea_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update an Idea by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update an idea using the idea ID and codeValuesIdea fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "ideaId":396101, "codeValuesIdea":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Update_an_Idea_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update an Idea to Assign a Boolean Configured Field", "description":"Payload to update an idea using the idea ID and configured field column label and text value.", "value":{ "ideaId":4005, "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_an_Idea":{ "summary":"Update an Idea", "description":"Payload to update an idea using the idea name, idea ID, workspace Id and idea status.", "value":{ "ideaId":4005, "ideaName":"Human Resource Planning - Civil Lines Project" }, "valueSetFlag":true }, "Update_an_Idea_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update an Idea by Assigning Code Values Using IDs", "description":"Payload to update an idea using the idea ID and codeValuesIdea fields such as code value ID and code type ID.", "value":{ "ideaId":396101, "codeValuesIdea":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_an_Idea_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update an Idea by Assigning Multiple Code Values Using IDs", "description":"Payload to update an idea using the idea ID and codeValuesIdea fields such as code value ID and code type ID.", "value":{ "ideaId":396101, "codeValuesIdea":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the idea service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"idea-put", "x-filename-id":"idea-put" }, "post":{ "tags":[ "Idea" ], "summary":"Create an Idea", "description":"Create an idea with the json object provided.", "operationId":"/idea_create_25", "requestBody":{ "description":"An idea object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityIdeaInput", "$ref":"#/components/schemas/ApiEntityIdeaInput", "exampleSetFlag":false }, "examples":{ "Create_an_Idea_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create an Idea by Assigning Code Values Using IDs", "description":"Payload to create an idea using the idea name, workspace code and idea code, and codeValuesIdea fields such as code value ID and code type ID.", "value":{ "ideaName":"Human Resource Planning", "ideaCode":"IDEA001", "workspaceCode":"Asia", "codeValuesIdea":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Create_an_Idea_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create an Idea by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create an idea using the idea name, workspace code and idea code, and codeValuesIdea fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "ideaName":"Human Resource Planning", "ideaCode":"IDEA001", "workspaceCode":"Asia", "codeValuesIdea":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Create an Idea by Assigning Multiple Code Values Using IDs":{ "summary":"Create an Idea by Assigning Multiple Code Values Using IDs", "description":"Payload to create an idea using the idea name, workspace code and idea code, and codeValuesIdea fields such as code value ID and code type ID.", "value":{ "ideaName":"Human Resource Planning", "ideaCode":"IDEA001", "workspaceCode":"Asia", "codeValuesIdea":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_an_Idea_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create an Idea by Assigning Code Values Using Codes", "description":"Payload to create an idea using the idea name, workspace code and idea code, and codeValuesIdea fields such as code value code and code type code.", "value":{ "ideaName":"Human Resource Planning", "ideaCode":"IDEA001", "workspaceCode":"Asia", "codeValuesIdea":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Create_an_Idea":{ "summary":"Create an Idea", "description":"Payload to create an idea using the idea name, workspace ID and idea status.", "value":{ "workspaceId":194001, "ideaName":"Human Resource Planning", "benefits":"Resource Estimation and Analysis" }, "valueSetFlag":true }, "Create_an_Idea_that_includes_Configured_Field_Text":{ "summary":"Create an Idea that includes Configured Field Text", "description":"Payload to create an idea using the idea name, workspace ID, idea status, and values for the configured field which include column name and text value.", "value":{ "workspaceId":194001, "ideaName":"Human Resource Planning", "status":"NEW", "configuredFields":[ { "columnName":"Notes", "textValue":"Idea Notes" } ] }, "valueSetFlag":true }, "Create_an_Idea_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create an Idea that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create an idea using the idea name, workspace ID, idea status, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "workspaceId":194001, "ideaName":"Human Resource Planning", "status":"NEW", "configuredFields":[ { "columnName":"Notes", "textValue":"Idea Notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the idea service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityIdea", "$ref":"#/components/schemas/ApiEntityIdea", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-post", "x-filename-id":"idea-post" } }, "/idea/batch":{ "put":{ "tags":[ "Idea" ], "summary":"Batch Update Ideas", "description":"Update multiple ideas with the list of json objects provided.", "operationId":"/idea/batch_updateBatch_21", "requestBody":{ "description":"One of more idea objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdeaInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Ideas":{ "summary":"Batch Update Ideas", "description":"Payload to update one or more ideas using the idea name, workspace ID, and idea status.", "value":[ { "ideaId":4003, "ideaName":"Remains discarding - James Street" }, { "ideaId":4003, "ideaName":"Resource Tender - 2" } ], "valueSetFlag":true }, "Batch_Update_Ideas_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Ideas by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update ideas using the idea ID and codeValuesIdea fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesIdea":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "ideaId":436446 }, { "codeValuesIdea":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "ideaId":436447 } ], "valueSetFlag":true }, "Batch_Update_Ideas_to_Assign_Configured_Field":{ "summary":"Batch Update Ideas to Assign Configured Field", "description":"Payload to update one or more ideas using the idea ID and configured field column name, column label, column definition ID, and text value.", "value":[ { "ideaId":4003, "configuredFields":[ { "columnName":"Notes", "textValue":"Idea Notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "ideaId":4003, "configuredFields":[ { "columnName":"Notes", "textValue":"Idea Notes" }, { "columnDefinationId":60045, "textValue":"N" } ] } ], "valueSetFlag":true }, "Batch_Update_Ideas_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Ideas by Assigning Code Values Using Codes or IDs", "description":"Payload to update ideas using the idea ID and codeValuesIdea fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "codeValuesIdea":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "ideaId":436446 }, { "codeValuesIdea":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "ideaId":436447 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the idea service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"idea-batch-put", "x-filename-id":"idea-batch-put" }, "post":{ "tags":[ "Idea" ], "summary":"Batch Create Ideas", "description":"Create multiple ideas with the list of json objects provided.", "operationId":"/idea/batch_createBatch_23", "requestBody":{ "description":"One of more idea objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdeaInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Ideas_that_include_Configured_Field_Text":{ "summary":"Batch Create Ideas that include Configured Field Text", "description":"Payload to create one or more ideas using the idea name, workspace ID, idea status and values for the configured field which include column name, column definition ID, text value.", "value":[ { "workspaceId":194001, "ideaName":"Remains discarding", "status":"NEW", "configuredFields":[ { "columnName":"Notes", "textValue":"Idea Notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "workspaceId":194001, "ideaName":"Resource Tender", "status":"NEW", "configuredFields":[ { "columnName":"Notes", "textValue":"Idea Notes" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true }, "Batch_Create_Ideas_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Ideas by Assigning Code Values Using Codes", "description":"Payload to create ideas using the idea name, workspace code and idea code, and codeValuesIdea fields such as code value code and code type code.", "value":[ { "codeValuesIdea":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ], "ideaName":"Human Resource Planning", "ideaCode":"IDEA001", "workspaceCode":"Asia" }, { "codeValuesIdea":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "ideaName":"Material Planning", "ideaCode":"IDEA002", "workspaceCode":"Asia" } ], "valueSetFlag":true }, "Batch_Create_Ideas_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Ideas by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create ideas using the idea name, workspace code and idea code, and codeValuesIdea fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesIdea":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "ideaName":"Human Resource Planning", "ideaCode":"IDEA001", "workspaceCode":"Asia" }, { "codeValuesIdea":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "ideaName":"Material Planning", "ideaCode":"IDEA002", "workspaceCode":"Asia" } ], "valueSetFlag":true }, "Batch_Create_Ideas":{ "summary":"Batch Create Ideas", "description":"Payload to create one or more ideas using the idea name, workspace ID and idea status.", "value":[ { "workspaceId":194001, "ideaName":"Remains discarding", "status":"NEW" }, { "workspaceId":194001, "ideaName":"Resource Tender", "status":"NEW" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the idea service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdea", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-batch-post", "x-filename-id":"idea-batch-post" }, "delete":{ "tags":[ "Idea" ], "summary":"Batch Delete Ideas", "description":"Delete an idea based on the ID provided.", "operationId":"/idea/batch_deleteBatch_24", "requestBody":{ "description":"One or more system-generated identifiers of an idea.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"idea-batch-delete", "x-filename-id":"idea-batch-delete" } }, "/idea/{ideaId}":{ "get":{ "tags":[ "Idea" ], "summary":"View an Idea", "description":"Returns an idea object based on the id provided.", "operationId":"/idea/{ideaId}_find_28", "parameters":[ { "name":"ideaId", "in":"path", "description":"The system-generated identifier of the idea.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested idea does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityIdea", "$ref":"#/components/schemas/ApiEntityIdea", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-{ideaId}-get", "x-filename-id":"idea-ideaid-get" }, "delete":{ "tags":[ "Idea" ], "summary":"Delete an Idea", "description":"Delete an idea based on the ID provided.", "operationId":"/idea/{ideaId}_delete_27", "parameters":[ { "name":"ideaId", "in":"path", "description":"The system-generated identifier of the idea.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"idea-{ideaId}-delete", "x-filename-id":"idea-ideaid-delete" } }, "/idea/workspace/code/{workspaceCode}":{ "get":{ "tags":[ "Idea" ], "summary":"View Ideas under a Workspace using Code", "description":"Returns all ideas under a workspace with the specified code. Filter on only idea name like for example: ideaName=*IDEA* and record count is supported.", "operationId":"/idea/workspace/code/{workspaceCode}_findByWorkspaceCode", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested idea does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdea", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-workspace-code-{workspaceCode}-get", "x-filename-id":"idea-workspace-code-workspacecode-get" } }, "/idea/{ideaName}/workspace/code/{workspaceCode}":{ "get":{ "tags":[ "Idea" ], "summary":"View Idea by Name and Workspace Code", "description":"Returns an idea with the specified name under a workspace with the given workspace code.", "operationId":"/idea/{ideaName}/workspace/code/{workspaceCode}_findByWorkspaceCodeAndName", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"ideaName", "in":"path", "description":"The user-specified name of the idea.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested idea does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityIdea", "$ref":"#/components/schemas/ApiEntityIdea", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-{ideaName}-workspace-code-{workspaceCode}-get", "x-filename-id":"idea-ideaname-workspace-code-workspacecode-get" } }, "/idea/workspace/{workspaceId}":{ "get":{ "tags":[ "Idea" ], "summary":"View Ideas under a Workspace", "description":"Returns all ideas under a workspace. Filter on only idea name like for example: ideaName=*IDEA* and record count is supported.", "operationId":"/idea/workspace/{workspaceId}_findByWorkspaceId_1", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested idea does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdea", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-workspace-{workspaceId}-get", "x-filename-id":"idea-workspace-workspaceid-get" } }, "/idea/{ideaName}/workspace/{workspaceId}":{ "get":{ "tags":[ "Idea" ], "summary":"View Ideas by Name and Workspace", "description":"Returns an idea object under a workspace with the specified code.", "operationId":"/idea/{ideaName}/workspace/{workspaceId}_findByWorkspaceIdAndName", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"ideaName", "in":"path", "description":"The user-specified name of the idea.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested idea does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityIdea", "$ref":"#/components/schemas/ApiEntityIdea", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-{ideaName}-workspace-{workspaceId}-get", "x-filename-id":"idea-ideaname-workspace-workspaceid-get" } }, "/idea/status/{status}/workspace/{workspaceId}":{ "get":{ "tags":[ "Idea" ], "summary":"View Ideas by Status and Workspace", "description":"Returns all ideas under a workspace with the given status.", "operationId":"/idea/status/{status}/workspace/{workspaceId}_findByWorkspaceIdAndStatus", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"status", "in":"path", "description":"Idea status.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NEW", "SUBMITTED", "ACCEPTED", "REJECTED", "OWNER_ASSIGNED", "PROPOSAL" ] } } ], "responses":{ "404":{ "description":"The requested idea does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdea", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-status-{status}-workspace-{workspaceId}-get", "x-filename-id":"idea-status-status-workspace-workspaceid-get" } }, "/idea/status/{status}":{ "get":{ "tags":[ "Idea" ], "summary":"Count Ideas with a Status", "description":"Returns the count of ideas with a given status. The service is not supported for cases other than record count so, is supposed to be used only with REC_COUNT_ONLY query.", "operationId":"/idea/status/{status}_findCountByStatus", "parameters":[ { "name":"status", "in":"path", "description":"Idea status.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NEW", "SUBMITTED", "ACCEPTED", "REJECTED", "OWNER_ASSIGNED", "PROPOSAL" ] } } ], "responses":{ "404":{ "description":"The requested idea does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"Integer", "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-status-{status}-get", "x-filename-id":"idea-status-status-get" } }, "/idea/permissionSets":{ "get":{ "tags":[ "Idea" ], "summary":"View Available Permission Sets for Idea", "description":"Send a request to this endpoint to view the available permission sets for the provided idea.", "operationId":"/idea/permissionSets_getPermissionSets_3", "parameters":[ { "name":"ideaId", "in":"query", "description":"The system-generated identifier of the idea.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"ideaName", "in":"query", "description":"The user-specified name of the idea.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPermissionSets", "$ref":"#/components/schemas/ApiEntityPermissionSets", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-permissionSets-get", "x-filename-id":"idea-permissionsets-get" } }, "/idea/removeUsers":{ "post":{ "tags":[ "Idea" ], "summary":"Remove Users Assigned to an Idea", "description":"Send a request to this endpoint to remove users from an idea.", "operationId":"/idea/removeUsers_removeUsers_1", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user removal sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"Remove user from input.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRemoveIdeaUserPermissions", "$ref":"#/components/schemas/ApiEntityRemoveIdeaUserPermissions", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the idea service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRemoveIdeaUserPermissionsResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-removeUsers-post", "x-filename-id":"idea-removeusers-post" } }, "/idea/syncBatch":{ "post":{ "tags":[ "Idea" ], "summary":"Batch Sync Ideas", "description":"Send a request to this endpoint to create or update one or more ideas.", "operationId":"/idea/syncBatch_syncBatch_23", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any idea record sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more idea objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdeaInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Ideas_with_Status":{ "summary":"Create or Update Ideas with Status", "description":"Payload to create or update ideas using the idea name, workspace ID, and idea status.", "value":[ { "workspaceId":194001, "ideaName":"Human Resource Planning", "status":"NEW" } ], "valueSetFlag":true }, "Create_or_Update_Ideas_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create or Update Ideas by Assigning Code Values Using Codes", "description":"Payload to create or update ideas using the idea code, workspace code, idea name, and codeValuesIdea fields such as code value code and code type code.", "value":[ { "codeValuesIdea":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ], "ideaName":"Human Resource Planning", "ideaCode":"IDEA001", "workspaceCode":"Asia" }, { "codeValuesIdea":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "ideaId":244756 } ], "valueSetFlag":true }, "Create_or_Update_Ideas_with_Benefits":{ "summary":"Create or Update Ideas with Benefits", "description":"Payload to create or update ideas using the idea name, workspace ID, and benefits.", "value":[ { "workspaceId":194001, "ideaName":"Human Resource Planning", "benefits":"Resource Estimation and Analysis" } ], "valueSetFlag":true }, "Create_or_Update_Ideas_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create or Update Ideas by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update ideas using the idea code, workspace code, idea name, and codeValuesIdea fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesIdea":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "ideaName":"Human Resource Planning", "ideaCode":"IDEA001", "workspaceCode":"Asia" }, { "codeValuesIdea":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "ideaId":244756 } ], "valueSetFlag":true }, "Create_or_Update_Ideas_to_Assign_a_Configured_Field":{ "summary":"Create or Update Ideas to Assign a Configured Field", "description":"Payload to create or update ideas using the idea code, workspace code, idea name, idea ID and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "configuredFields":[ { "columnLabel":"Notes", "textValue":"Idea Notes" }, { "columnDefinationId":61045, "textValue":"N" } ], "ideaName":"Human Resource Planning", "ideaCode":"IDEA001", "workspaceCode":"Asia" }, { "configuredFields":[ { "columnLabel":"Notes", "textValue":"Idea Notes" }, { "columnDefinationId":60045, "numberValue":2 } ], "ideaId":244756 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"idea-syncBatch-post", "x-filename-id":"idea-syncbatch-post" } }, "/location":{ "put":{ "tags":[ "Location" ], "summary":"Update a Location", "description":"Send a request to this endpoint to update a location. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/location_update_25", "requestBody":{ "description":"Location to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityLocationInput", "$ref":"#/components/schemas/ApiEntityLocationInput", "exampleSetFlag":false }, "examples":{ "Update_a_Location_Using_Location_ID":{ "summary":"Update a Location Using Location ID", "description":"Payload to update name of a location using location ID.", "value":{ "locationName":"New York Office", "locationId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Location service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"location-put", "x-filename-id":"location-put" }, "post":{ "tags":[ "Location" ], "summary":"Create a Location", "description":"Send a request to this endpoint to create a location. An application object will be created using the JSON data provided in the request body.", "operationId":"/location_create_26", "requestBody":{ "description":"Location to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityLocationInput", "$ref":"#/components/schemas/ApiEntityLocationInput", "exampleSetFlag":false }, "examples":{ "Create_a_Location":{ "summary":"Create a Location", "description":"Payload to create a location using workspace ID, location code, and location name.", "value":{ "locationCode":"Office", "locationName":"Office", "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Location service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityLocation", "$ref":"#/components/schemas/ApiEntityLocation", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"location-post", "x-filename-id":"location-post" } }, "/location/batch":{ "put":{ "tags":[ "Location" ], "summary":"Batch Update Locations", "description":"Send a request to this endpoint to update one or more locations. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/location/batch_updateBatch_22", "requestBody":{ "description":"Updates the location for the specified location IDs.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityLocationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Locations_Using_Location_IDs":{ "summary":"Batch Update Locations Using Location IDs", "description":"Payload to update name of one or more locations using location IDs.", "value":[ { "locationName":"New York Office", "locationId":10001 }, { "locationName":"New York Warehouse", "locationId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Location service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"location-batch-put", "x-filename-id":"location-batch-put" }, "post":{ "tags":[ "Location" ], "summary":"Batch Create Locations", "description":"Send a request to this endpoint to create one or more locations. An application object will be created for each JSON object provided in the request body.", "operationId":"/location/batch_createBatch_24", "requestBody":{ "description":"Location objects to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityLocationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Locations":{ "summary":"Batch Create Locations", "description":"Payload to create one or more locations using workspace ID, location code, and location name.", "value":[ { "locationCode":"Office", "locationName":"Office", "workspaceId":10001 }, { "locationCode":"Warehouse", "locationName":"Warehouse", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Location service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityLocation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"location-batch-post", "x-filename-id":"location-batch-post" }, "delete":{ "tags":[ "Location" ], "summary":"Batch Delete Locations", "description":"Send a request to this endpoint to delete one or more locations. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/location/batch_deleteBatch_25", "requestBody":{ "description":"IDs of the Location to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Location service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"location-batch-delete", "x-filename-id":"location-batch-delete" } }, "/location/{locationId}":{ "get":{ "tags":[ "Location" ], "summary":"View a Location", "description":"This endpoint returns locations that meet the following requirements:
  • The object has an ID that matches the value of the {locationId} path parameter.
", "operationId":"/location/{locationId}_find_29", "parameters":[ { "name":"locationId", "in":"path", "description":"ID of the Location to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested location does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityLocation", "$ref":"#/components/schemas/ApiEntityLocation", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"location-{locationId}-get", "x-filename-id":"location-locationid-get" }, "delete":{ "tags":[ "Location" ], "summary":"Delete a Location", "description":"Send a request to this endpoint to delete a location. The application object with an ID value that matches the value of the {locationId} path parameter will be deleted.", "operationId":"/location/{locationId}_delete_28", "parameters":[ { "name":"locationId", "in":"path", "description":"ID of the Location to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Location service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"location-{locationId}-delete", "x-filename-id":"location-locationid-delete" } }, "/location/code/{locationCode}":{ "get":{ "tags":[ "Location" ], "summary":"View a Location by Code", "description":"This endpoint returns locations that meet the following requirements:
  • The object has a code that matches the value of the {locationCode} path parameter.
", "operationId":"/location/code/{locationCode}_findByCode_7", "parameters":[ { "name":"locationCode", "in":"path", "description":"Code of the location to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested location does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityLocation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"location-code-{locationCode}-get", "x-filename-id":"location-code-locationcode-get" } }, "/location/workspace/{workspaceId}/code/{locationCode}":{ "get":{ "tags":[ "Location" ], "summary":"View a Location by Code and Workspace", "description":"This endpoint returns locations that meet the following requirements:
  • The object has a code that matches the value of the {locationCode} path parameter.
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/location/workspace/{workspaceId}/code/{locationCode}_findByCodeAndWorkspace_3", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"locationCode", "in":"path", "description":"Code of the location to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested location does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityLocation", "$ref":"#/components/schemas/ApiEntityLocation", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"location-workspace-{workspaceId}-code-{locationCode}-get", "x-filename-id":"location-workspace-workspaceid-code-locationcode-get" } }, "/location/name/{locationName}":{ "get":{ "tags":[ "Location" ], "summary":"View a Location by Name", "description":"This endpoint returns locations that meet the following requirements:
  • The object has a name that matches the value of the {locationName} path parameter.
", "operationId":"/location/name/{locationName}_getLocationByName", "parameters":[ { "name":"locationName", "in":"path", "description":"Name of the location to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested location does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityLocation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"location-name-{locationName}-get", "x-filename-id":"location-name-locationname-get" } }, "/location/workspace/{workspaceId}":{ "get":{ "tags":[ "Location" ], "summary":"View a Location by Workspace", "description":"This endpoint returns locations that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/location/workspace/{workspaceId}_getLocationsByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested location does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityLocation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"location-workspace-{workspaceId}-get", "x-filename-id":"location-workspace-workspaceid-get" } }, "/location/syncBatch":{ "post":{ "tags":[ "Location" ], "summary":"Batch Sync Location", "description":"Send a request to this endpoint to create or update one or more locations.", "operationId":"/location/syncBatch_syncBatch_24", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any location sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more location objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityLocationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Location_with_a_Push Down Type":{ "summary":"Create or Update a Location with a Push Down Type", "description":"Payload to create or update a location using the workspace ID, location code, location name, and push down type which is either manual or automatic.", "value":[ { "workspaceId":10001, "locationName":"Office", "locationCode":"Office", "pushDownType":"MANUAL" } ], "valueSetFlag":true }, "Create_or_Update_a_Location":{ "summary":"Create or Update a Location", "description":"Payload to create or update a location using the workspace ID, location code, and location name.", "value":[ { "locationCode":"Office", "locationName":"Office", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Location service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"location-syncBatch-post", "x-filename-id":"location-syncbatch-post" } }, "/monteCarloActivityDelta/{monteCarloActivityDeltaId}":{ "get":{ "tags":[ "Monte Carlo Activity Delta" ], "summary":"View a Monte Carlo Activity Delta ", "description":"This endpoint returns Monte Carlo activity deltas that meet the following requirements:
  • The object has an ID that matches the value of the {monteCarloActivityDeltaId} path parameter.
", "operationId":"/monteCarloActivityDelta/{monteCarloActivityDeltaId}_find_30", "parameters":[ { "name":"monteCarloActivityDeltaId", "in":"path", "description":"ID of MonteCarlo Activity Delta to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity delta does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloActivityDelta", "$ref":"#/components/schemas/ApiEntityMonteCarloActivityDelta", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityDelta-{monteCarloActivityDeltaId}-get", "x-filename-id":"montecarloactivitydelta-montecarloactivitydeltaid-get" } }, "/monteCarloActivityDelta/activity/{activityId}":{ "get":{ "tags":[ "Monte Carlo Activity Delta" ], "summary":"View a Monte Carlo Activity Delta by Activity ", "description":"This endpoint returns Monte Carlo activity deltas that meet the following requirements:
  • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
", "operationId":"/monteCarloActivityDelta/activity/{activityId}_findByActivity", "parameters":[ { "name":"activityId", "in":"path", "description":"Activity ID of which MonteCarlo Activity Delta has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity delta does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityDelta", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityDelta-activity-{activityId}-get", "x-filename-id":"montecarloactivitydelta-activity-activityid-get" } }, "/monteCarloActivityDeterministicValues/{monteCarloActivityDeterministicValuesId}":{ "get":{ "tags":[ "Monte Carlo Activity Deterministic Values" ], "summary":"View Monte Carlo Activity Deterministic Values ", "description":"This endpoint returns Monte Carlo activity deterministic values that meet the following requirements:
  • The object has an ID that matches the value of the {monteCarloActivityDeterministicValuesId} path parameter.
", "operationId":"/monteCarloActivityDeterministicValues/{monteCarloActivityDeterministicValuesId}_find_31", "parameters":[ { "name":"monteCarloActivityDeterministicValuesId", "in":"path", "description":"ID of MonteCarlo Activity Deterministic Value to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity deterministic value does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloActivityDeterministicValues", "$ref":"#/components/schemas/ApiEntityMonteCarloActivityDeterministicValues", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityDeterministicValues-{monteCarloActivityDeterministicValuesId}-get", "x-filename-id":"montecarloactivitydeterministicvalues-montecarloactivitydeterministicvaluesid-get" } }, "/monteCarloActivityDeterministicValues/activity/{activityId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Activity Deterministic Values" ], "summary":"View Monte Carlo Activity Deterministic Values by Activity and Scenario", "description":"This endpoint returns Monte Carlo activity deterministic values that meet the following requirements:
  • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloActivityDeterministicValues/activity/{activityId}/scenario/{scenario}_findByActivity_1", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"activityId", "in":"path", "description":"Activity ID of which MonteCarlo Activity Deterministic Value has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity deterministic value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityDeterministicValues", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityDeterministicValues-activity-{activityId}-scenario-{scenario}-get", "x-filename-id":"montecarloactivitydeterministicvalues-activity-activityid-scenario-scenario-get" } }, "/monteCarloActivityDeterministicValues/project/{projectId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Activity Deterministic Values" ], "summary":"View Monte Carlo Activity Deterministic Values by Project and Scenario", "description":"This endpoint returns Monte Carlo activity deterministic values that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloActivityDeterministicValues/project/{projectId}/scenario/{scenario}_findByProject", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"projectId", "in":"path", "description":"Project ID of which MonteCarlo Activity Deterministic Value has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity deterministic value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityDeterministicValues", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityDeterministicValues-project-{projectId}-scenario-{scenario}-get", "x-filename-id":"montecarloactivitydeterministicvalues-project-projectid-scenario-scenario-get" } }, "/monteCarloActivityDeterministicValues/parentCode":{ "get":{ "tags":[ "Monte Carlo Activity Deterministic Values" ], "summary":"View All Monte Carlo Activity Deterministic Values by Parent", "description":"Send a request to this endpoint to view all Monte Carlo activity deterministic values under parent with codes matching the code fields in query parameters.", "operationId":"/monteCarloActivityDeterministicValues/parentCode_getAllMonteCarloActivityDeterministicValuesByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityCode", "in":"query", "description":"The user-specified identifier of an activity.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenario", "in":"query", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.

This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity deterministic value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityDeterministicValues", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityDeterministicValues-parentCode-get", "x-filename-id":"montecarloactivitydeterministicvalues-parentcode-get" } }, "/monteCarloActivityIterationValues/activity/{activityId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Activity Iteration Values" ], "summary":"View All Monte Carlo Activity Iteration Values by Activity ID and Scenario", "description":"This endpoint returns Monte Carlo Activity Iteration Values that meet the following requirements:
  • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloActivityIterationValues/activity/{activityId}/scenario/{scenario}_findByActivity_2", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"activityId", "in":"path", "description":"Activity ID of which Monte Carlo Activity Iteration Values has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo Activity Iteration Values does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityIterationValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityIterationValues-activity-{activityId}-scenario-{scenario}-get", "x-filename-id":"montecarloactivityiterationvalues-activity-activityid-scenario-scenario-get" } }, "/monteCarloActivityIterationValues/project/{projectId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Activity Iteration Values" ], "summary":"View All Monte Carlo Activity Iteration Values by Project ID and Scenario", "description":"This endpoint returns Monte Carlo Activity Iteration Values that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloActivityIterationValues/project/{projectId}/scenario/{scenario}_findByProject_1", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"projectId", "in":"path", "description":"Project ID of which Monte Carlo Activity Iteration Values has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo Activity Iteration Values does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityIterationValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityIterationValues-project-{projectId}-scenario-{scenario}-get", "x-filename-id":"montecarloactivityiterationvalues-project-projectid-scenario-scenario-get" } }, "/monteCarloActivityIterationValues/parentCode":{ "get":{ "tags":[ "Monte Carlo Activity Iteration Values" ], "summary":"View All Monte Carlo Activity Iteration Values by Parent Codes", "description":"Send a request to this endpoint to view all Monte Carlo Activity Iteration Values under parent with codes matching the code fields in query parameters.", "operationId":"/monteCarloActivityIterationValues/parentCode_getAllMonteCarloActivityIterationValueByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityCode", "in":"query", "description":"The user-specified identifier of an activity.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenario", "in":"query", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.

This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo Activity Iteration Values does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityIterationValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityIterationValues-parentCode-get", "x-filename-id":"montecarloactivityiterationvalues-parentcode-get" } }, "/monteCarloActivityResult/{monteCarloActivityResultId}":{ "get":{ "tags":[ "Monte Carlo Activity Result" ], "summary":"View Monte Carlo Activity Result", "description":"This endpoint returns Monte Carlo activities that meet the following requirements:
  • The object has an ID that matches the value of the {monteCarloActivityResultId} path parameter.
", "operationId":"/monteCarloActivityResult/{monteCarloActivityResultId}_find_32", "parameters":[ { "name":"monteCarloActivityResultId", "in":"path", "description":"The system-generated identifier of a Monte Carlo activity result.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity result does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloActivityResult", "$ref":"#/components/schemas/ApiEntityMonteCarloActivityResult", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityResult-{monteCarloActivityResultId}-get", "x-filename-id":"montecarloactivityresult-montecarloactivityresultid-get" } }, "/monteCarloActivityResult/activity/{activityId}":{ "get":{ "tags":[ "Monte Carlo Activity Result" ], "summary":"View Monte Carlo Activity Results by Activity ", "description":"This endpoint returns Monte Carlo activities that meet the following requirements:
  • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
", "operationId":"/monteCarloActivityResult/activity/{activityId}_getActivityResultsByActivity", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity result does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityResult", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityResult-activity-{activityId}-get", "x-filename-id":"montecarloactivityresult-activity-activityid-get" } }, "/monteCarloActivityResult/project/{projectId}":{ "get":{ "tags":[ "Monte Carlo Activity Result" ], "summary":"View Monte Carlo Activity Results by Project", "description":"This endpoint returns Monte Carlo activities that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/monteCarloActivityResult/project/{projectId}_getActivityResultsByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity result does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityResult", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityResult-project-{projectId}-get", "x-filename-id":"montecarloactivityresult-project-projectid-get" } }, "/monteCarloActivityRiskResult/{monteCarloActivityRiskResultId}":{ "get":{ "tags":[ "Monte Carlo Activity Risk Result" ], "summary":"View Monte Carlo Activity Risk Results ", "description":"This endpoint returns Monte Carlo activity risk results that meet the following requirements:
  • The object has an ID that matches the value of the {monteCarloActivityRiskResultId} path parameter.
", "operationId":"/monteCarloActivityRiskResult/{monteCarloActivityRiskResultId}_find_33", "parameters":[ { "name":"monteCarloActivityRiskResultId", "in":"path", "description":"ID of MonteCarlo Activity Risk Result to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity risk result does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloActivityRiskResult", "$ref":"#/components/schemas/ApiEntityMonteCarloActivityRiskResult", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityRiskResult-{monteCarloActivityRiskResultId}-get", "x-filename-id":"montecarloactivityriskresult-montecarloactivityriskresultid-get" } }, "/monteCarloActivityRiskResult/projectRisk/{projectRiskId}":{ "get":{ "tags":[ "Monte Carlo Activity Risk Result" ], "summary":"View Monte Carlo Activity Risk Results by Project Risk ", "description":"This endpoint returns Monte Carlo activity risk results that meet the following requirements:
  • The object is associated with a project risk with an ID value that matches the value of the {projectRiskId} path parameter.
", "operationId":"/monteCarloActivityRiskResult/projectRisk/{projectRiskId}_findByProject_2", "parameters":[ { "name":"projectRiskId", "in":"path", "description":"Project Risk ID of which MonteCarlo Activity Risk Result has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo activity risk result does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityRiskResult", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloActivityRiskResult-projectRisk-{projectRiskId}-get", "x-filename-id":"montecarloactivityriskresult-projectrisk-projectriskid-get" } }, "/monteCarloProjectDelta/{monteCarloProjectDeltaId}":{ "get":{ "tags":[ "Monte Carlo Project Delta" ], "summary":"View a Monte Carlo Project Delta ", "description":"This endpoint returns Monte Carlo project deltas that meet the following requirements:
  • The object has an ID that matches the value of the {monteCarloProjectDeltaId} path parameter.
", "operationId":"/monteCarloProjectDelta/{monteCarloProjectDeltaId}_find_34", "parameters":[ { "name":"monteCarloProjectDeltaId", "in":"path", "description":"ID of MonteCarlo Project Delta to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo project delta does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloProjectDelta", "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDelta", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectDelta-{monteCarloProjectDeltaId}-get", "x-filename-id":"montecarloprojectdelta-montecarloprojectdeltaid-get" } }, "/monteCarloProjectDelta/project/{projectId}/deltaScenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Project Delta" ], "summary":"View Monte Carlo Project Delta by Project and Scenario", "description":"This endpoint returns Monte Carlo project deltas that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloProjectDelta/project/{projectId}/deltaScenario/{scenario}_findByProject_3", "parameters":[ { "name":"scenario", "in":"path", "description":"Risk analysis results delta.
Allowed Values: [ \"ORG_PRE_TO_ORG_POST\", \"ORG_PRE_TO_SENS_PRE\", \"ORG_POST_TO_SENS_POST\", \"PRE_MEAN_IMPACTED\", \"POST_MEAN_IMPACTED\" ]", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORG_PRE_TO_ORG_POST", "ORG_PRE_TO_SENS_PRE", "ORG_POST_TO_SENS_POST", "PRE_MEAN_IMPACTED", "POST_MEAN_IMPACTED" ] } }, { "name":"projectId", "in":"path", "description":"Project ID of which MonteCarlo Project Delta has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo project delta does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloProjectDelta", "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDelta", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectDelta-project-{projectId}-deltaScenario-{scenario}-get", "x-filename-id":"montecarloprojectdelta-project-projectid-deltascenario-scenario-get" } }, "/monteCarloProjectDelta/parentCode":{ "get":{ "tags":[ "Monte Carlo Project Delta" ], "summary":"View All Monte Carlo Project Deltas by Parent", "description":"Send a request to this endpoint to view all Monte Carlo project deltas under parent with codes matching the code fields in query parameters.", "operationId":"/monteCarloProjectDelta/parentCode_getAllMonteCarloProjectDeltasByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenario", "in":"query", "description":"Risk analysis results delta.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORG_PRE_TO_ORG_POST", "ORG_PRE_TO_SENS_PRE", "ORG_POST_TO_SENS_POST", "PRE_MEAN_IMPACTED", "POST_MEAN_IMPACTED" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo project delta does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDelta", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectDelta-parentCode-get", "x-filename-id":"montecarloprojectdelta-parentcode-get" } }, "/monteCarloProjectDeterministicValues/{id}":{ "get":{ "tags":[ "Monte Carlo Project Deterministic Values" ], "summary":"View Monte Carlo Project Deterministic Values ", "description":"This endpoint returns Monte Carlo project deterministic values that meet the following requirements:
  • The object has an ID that matches the value of the {id} path parameter.
", "operationId":"/monteCarloProjectDeterministicValues/{id}_find_35", "parameters":[ { "name":"id", "in":"path", "description":"ID of MonteCarlo Project Deterministic Values to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Monte Carlo project deterministic values do not exist, or you do not have access to them." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloProjectDeterministicValues", "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDeterministicValues", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectDeterministicValues-{id}-get", "x-filename-id":"montecarloprojectdeterministicvalues-id-get" } }, "/monteCarloProjectDeterministicValues/project/{projectId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Project Deterministic Values" ], "summary":"View Monte Carlo Project Deterministic Values by Project and Scenario", "description":"This endpoint returns Monte Carlo deterministic values that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloProjectDeterministicValues/project/{projectId}/scenario/{scenario}_findByProject_4", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"projectId", "in":"path", "description":"Project ID of which MonteCarlo Project Deterministic Values has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Monte Carlo project deterministic values do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDeterministicValues", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectDeterministicValues-project-{projectId}-scenario-{scenario}-get", "x-filename-id":"montecarloprojectdeterministicvalues-project-projectid-scenario-scenario-get" } }, "/monteCarloProjectDeterministicValues/parentCode":{ "get":{ "tags":[ "Monte Carlo Project Deterministic Values" ], "summary":"View All Monte Carlo Project Deterministic Values by Parent", "description":"Send a request to this endpoint to view all Monte Carlo project deterministic values under parent with codes matching the code fields in query parameters.", "operationId":"/monteCarloProjectDeterministicValues/parentCode_getAllMonteCarloProjectDeterministicValuesByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenario", "in":"query", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.

This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } } ], "responses":{ "404":{ "description":"The Monte Carlo project deterministic values do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDeterministicValues", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectDeterministicValues-parentCode-get", "x-filename-id":"montecarloprojectdeterministicvalues-parentcode-get" } }, "/monteCarloProjectIterationValues/project/{projectId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Project Iteration Values" ], "summary":"View All Monte Carlo Project Iteration Values by Project ID and Scenario", "description":"This endpoint returns Monte Carlo Project Iteration Values that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloProjectIterationValues/project/{projectId}/scenario/{scenario}_findByProject_5", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"projectId", "in":"path", "description":"Project ID of which Monte Carlo Project Iteration Values has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Monte Carlo Project Iteration Values do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloProjectIterationValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectIterationValues-project-{projectId}-scenario-{scenario}-get", "x-filename-id":"montecarloprojectiterationvalues-project-projectid-scenario-scenario-get" } }, "/monteCarloProjectIterationValues/parentCode":{ "get":{ "tags":[ "Monte Carlo Project Iteration Values" ], "summary":"View All Monte Carlo Project Iteration Values by Parent Codes", "description":"Send a request to this endpoint to view all Monte Carlo Project Iteration Values under parent with codes matching the code fields in query parameters.", "operationId":"/monteCarloProjectIterationValues/parentCode_getAllMonteCarloProjectIterationValueByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenario", "in":"query", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.

This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } } ], "responses":{ "404":{ "description":"The Monte Carlo Project Iteration Values do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloProjectIterationValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectIterationValues-parentCode-get", "x-filename-id":"montecarloprojectiterationvalues-parentcode-get" } }, "/monteCarloProjectResult/{monteCarloProjectResultId}":{ "get":{ "tags":[ "Monte Carlo Project Result" ], "summary":"View a Monte Carlo Project Result ", "description":"This endpoint returns Monte Carlo project results that meet the following requirements:
  • The object has an ID that matches the value of the {monteCarloProjectResultId} path parameter.
", "operationId":"/monteCarloProjectResult/{monteCarloProjectResultId}_find_36", "parameters":[ { "name":"monteCarloProjectResultId", "in":"path", "description":"ID of MonteCarlo Project Result to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo project result does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloProjectResult", "$ref":"#/components/schemas/ApiEntityMonteCarloProjectResult", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectResult-{monteCarloProjectResultId}-get", "x-filename-id":"montecarloprojectresult-montecarloprojectresultid-get" } }, "/monteCarloProjectResult/project/{projectId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Project Result" ], "summary":"View a Monte Carlo Project Result by Project and Scenario", "description":"This endpoint returns a Monte Carlo project results that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloProjectResult/project/{projectId}/scenario/{scenario}_findByProject_6", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"projectId", "in":"path", "description":"Project ID of which MonteCarlo Project Result has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo project result does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloProjectResult", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectResult-project-{projectId}-scenario-{scenario}-get", "x-filename-id":"montecarloprojectresult-project-projectid-scenario-scenario-get" } }, "/monteCarloProjectResult/parentCode":{ "get":{ "tags":[ "Monte Carlo Project Result" ], "summary":"View All Monte Carlo Project Results by Parent", "description":"Send a request to this endpoint to view all Monte Carlo project results under parent with codes matching the code fields in query parameters.", "operationId":"/monteCarloProjectResult/parentCode_getAllMonteCarloProjectResultByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenario", "in":"query", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.

This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo project result does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloProjectResult", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloProjectResult-parentCode-get", "x-filename-id":"montecarloprojectresult-parentcode-get" } }, "/monteCarloRiskResult/{monteCarloRiskResultId}":{ "get":{ "tags":[ "Monte Carlo Risk Result" ], "summary":"View a Monte Carlo Risk Result ", "description":"This endpoint returns a Monte Carlo risk results that meet the following requirements:
  • The object has an ID that matches the value of the {monteCarloRiskResultId} path parameter.
", "operationId":"/monteCarloRiskResult/{monteCarloRiskResultId}_find_37", "parameters":[ { "name":"monteCarloRiskResultId", "in":"path", "description":"ID of MonteCarlo Risk Result to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo risk result does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloRiskResult", "$ref":"#/components/schemas/ApiEntityMonteCarloRiskResult", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloRiskResult-{monteCarloRiskResultId}-get", "x-filename-id":"montecarloriskresult-montecarloriskresultid-get" } }, "/monteCarloRiskResult/project/{projectId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Risk Result" ], "summary":"View a Monte Carlo Risk Result by Project and Scenario", "description":"This endpoint returns a Monte Carlo risk results that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloRiskResult/project/{projectId}/scenario/{scenario}_findByProject_7", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"projectId", "in":"path", "description":"Project ID of which MonteCarlo Risk Result has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo risk result does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloRiskResult", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloRiskResult-project-{projectId}-scenario-{scenario}-get", "x-filename-id":"montecarloriskresult-project-projectid-scenario-scenario-get" } }, "/monteCarloRiskResult/projectRisk/{projectRiskId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Risk Result" ], "summary":"View a Monte Carlo Risk Result by Project Risk and Scenario", "description":"This endpoint returns a Monte Carlo risk results that meet the following requirements:
  • The object is associated with a project risk with an ID value that matches the value of the {projectRiskId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloRiskResult/projectRisk/{projectRiskId}/scenario/{scenario}_findByProjectRisk", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"projectRiskId", "in":"path", "description":"Project Risk ID of which MonteCarlo Risk Result has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo risk result does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloRiskResult", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloRiskResult-projectRisk-{projectRiskId}-scenario-{scenario}-get", "x-filename-id":"montecarloriskresult-projectrisk-projectriskid-scenario-scenario-get" } }, "/monteCarloRunSettings/{monteCarloRunSettingsId}":{ "get":{ "tags":[ "Monte Carlo Run Settings" ], "summary":"View Monte Carlo Run Settings ", "description":"This endpoint returns Monte Carlo run settings that meet the following requirements:
  • The object has an ID that matches the value of the {monteCarloRunSettingsId} path parameter.
", "operationId":"/monteCarloRunSettings/{monteCarloRunSettingsId}_find_38", "parameters":[ { "name":"monteCarloRunSettingsId", "in":"path", "description":"ID of MonteCarlo Run Settings to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo run settings do not exist, or you do not have access to them." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloRunSettings", "$ref":"#/components/schemas/ApiEntityMonteCarloRunSettings", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloRunSettings-{monteCarloRunSettingsId}-get", "x-filename-id":"montecarlorunsettings-montecarlorunsettingsid-get" } }, "/monteCarloRunSettings/parentCode":{ "get":{ "tags":[ "Monte Carlo Run Settings" ], "summary":"View All Monte Carlo Run Settings by Parent", "description":"Send a request to this endpoint to view all Monte Carlo run settings under parent with codes matching the code fields in query parameters.", "operationId":"/monteCarloRunSettings/parentCode_findAllMonteCarloRunSettingsByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenario", "in":"query", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.

This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo run settings do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloRunSettings", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloRunSettings-parentCode-get", "x-filename-id":"montecarlorunsettings-parentcode-get" } }, "/monteCarloRunSettings/project/{projectId}/scenario/{scenario}":{ "get":{ "tags":[ "Monte Carlo Run Settings" ], "summary":"View Monte Carlo Run Settings by Project and Scenario", "description":"This endpoint returns Monte Carlo run settings that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object was run under a scenario that matches the value of the {scenario} path parameter.
", "operationId":"/monteCarloRunSettings/project/{projectId}/scenario/{scenario}_findByProject_8", "parameters":[ { "name":"scenario", "in":"path", "description":"The type of risk analysis run on a project.
  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
  • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] } }, { "name":"projectId", "in":"path", "description":"Project ID of which MonteCarlo Run Settings has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo run settings do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloRunSettings", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloRunSettings-project-{projectId}-scenario-{scenario}-get", "x-filename-id":"montecarlorunsettings-project-projectid-scenario-scenario-get" } }, "/monteCarloSettings/createDefault/{projectId}":{ "post":{ "tags":[ "Monte Carlo Settings" ], "summary":"Create Default Monte Carlo Settings for a Project", "description":"Send a request to this endpoint to create default Monte Carlo settings for a project that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/monteCarloSettings/createDefault/{projectId}_create_27", "parameters":[ { "name":"projectId", "in":"path", "description":"ID of Project on which MonteCarlo setting object has to be created. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input for the Monte Carlo Settings service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloSettings", "$ref":"#/components/schemas/ApiEntityMonteCarloSettings", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloSettings-createDefault-{projectId}-post", "x-filename-id":"montecarlosettings-createdefault-projectid-post" } }, "/monteCarloSettings/{monteCarloSettingsId}":{ "get":{ "tags":[ "Monte Carlo Settings" ], "summary":"View Monte Carlo Settings ", "description":"This endpoint returns Monte Carlo settings that meet the following requirements:
  • The object has an ID that matches the value of the {monteCarloSettingsId} path parameter.
", "operationId":"/monteCarloSettings/{monteCarloSettingsId}_find_39", "parameters":[ { "name":"monteCarloSettingsId", "in":"path", "description":"ID of MonteCarlo Settings to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo settings do not exist, or you do not have access to them." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloSettings", "$ref":"#/components/schemas/ApiEntityMonteCarloSettings", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloSettings-{monteCarloSettingsId}-get", "x-filename-id":"montecarlosettings-montecarlosettingsid-get" } }, "/monteCarloSettings/parentCode":{ "get":{ "tags":[ "Monte Carlo Settings" ], "summary":"View All Monte Carlo Settings by Parent", "description":"Send a request to this endpoint to view all Monte Carlo settings under parent with codes matching the code fields in query parameters.", "operationId":"/monteCarloSettings/parentCode_findAllMonteCarloSettingsByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo settings do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloSettings", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloSettings-parentCode-get", "x-filename-id":"montecarlosettings-parentcode-get" } }, "/monteCarloSettings/project/{projectId}":{ "get":{ "tags":[ "Monte Carlo Settings" ], "summary":"View Monte Carlo Settings by Project ", "description":"This endpoint returns Monte Carlo settings that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/monteCarloSettings/project/{projectId}_findByProject_9", "parameters":[ { "name":"projectId", "in":"path", "description":"Project ID of which MonteCarlo Settings has to be returned.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Monte Carlo settings do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloSettings", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"monteCarloSettings-project-{projectId}-get", "x-filename-id":"montecarlosettings-project-projectid-get" } }, "/monteCarloSettings":{ "put":{ "tags":[ "Monte Carlo Settings" ], "summary":"Update Monte Carlo Settings ", "description":"Send a request to this endpoint to update a Monte Carlo settings object. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/monteCarloSettings_update_26", "requestBody":{ "description":"The MonteCarlo Setting to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMonteCarloSettingsInput", "$ref":"#/components/schemas/ApiEntityMonteCarloSettingsInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Monte Carlo Settings service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"monteCarloSettings-put", "x-filename-id":"montecarlosettings-put" } }, "/monteCarloSettings/batch":{ "put":{ "tags":[ "Monte Carlo Settings" ], "summary":"Batch Update Monte Carlo Settings ", "description":"Send a request to this endpoint to update one or more Monte Carlo settings. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/monteCarloSettings/batch_updateBatch_23", "requestBody":{ "description":"The MonteCarlo Settings to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloSettingsInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Monte Carlo Settings service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"monteCarloSettings-batch-put", "x-filename-id":"montecarlosettings-batch-put" } }, "/notebookTopic/assign":{ "put":{ "tags":[ "Notebook Topics" ], "summary":"Assign Notebook Topics", "description":"Send a request to this endpoint to assign notebook topics to applicable business objects like Activities, Projects etc.", "operationId":"/notebookTopic/assign_assign", "requestBody":{ "description":"One or more notebook topic assignment objects.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityNotebookTopicsAssignmentInput", "$ref":"#/components/schemas/ApiEntityNotebookTopicsAssignmentInput", "exampleSetFlag":false }, "examples":{ "Assign_Notebook_Topics_to_WBS_Project_and_Activities":{ "summary":"Assign Notebook Topics to WBS, Project and Activities", "description":"Payload to assign one or more notebook topics to multiple activities, multiple WBSs, and multiple projects using the notebook topic name, notes, and respective identifiers.", "value":{ "activityNotes":[ { "notebookTopicName":"Note2", "notes":"activity notes", "activityIdentifier":{ "activityId":4425701 } } ], "wbsNotes":[ { "notebookTopicName":"Note2", "notes":"wbs botes", "wbsIdentifier":{ "wbsId":3646905 } } ], "projectNotes":[ { "notebookTopicName":"Note2", "notes":"project notes", "projectIdentifier":{ "projectId":844601 } } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"notebookTopic-assign-put", "x-filename-id":"notebooktopic-assign-put" } }, "/notebookTopic":{ "put":{ "tags":[ "Notebook Topics" ], "summary":"Update a Notebook Topic", "description":"Send a request to this endpoint to update a notebook topic.", "operationId":"/notebookTopic_update_27", "requestBody":{ "description":"A notebook topic object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityNotebookTopicsInput", "$ref":"#/components/schemas/ApiEntityNotebookTopicsInput", "exampleSetFlag":false }, "examples":{ "Update_a_Notebook_Topic_Name_using_Notebook_Topic_ID":{ "summary":"Update a Notebook Topic Name using Notebook Topic ID", "description":"Payload to update a notebook topic name using the notebook topic ID and notebook topic name.", "value":{ "notebookTopicId":154405, "notebookTopicName":"Note-2" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"notebookTopic-put", "x-filename-id":"notebooktopic-put" }, "post":{ "tags":[ "Notebook Topics" ], "summary":"Create a Notebook Topic", "description":"Send a request to this endpoint to create a notebook topic.", "operationId":"/notebookTopic_create_28", "requestBody":{ "description":"A notebook topic object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityNotebookTopicsInput", "$ref":"#/components/schemas/ApiEntityNotebookTopicsInput", "exampleSetFlag":false }, "examples":{ "Create_a_Notebook_Topic_using_WorkspaceId":{ "summary":"Create a Notebook Topic using WorkspaceId", "description":"Payload to create a notebook topic using the notebook topic name, workspace ID, and notebook topics that apply for the objects.", "value":{ "workspaceId":5001, "notebookTopicName":"Note2", "appliesTo":[ "ACTIVITY", "WBS", "PROJECT" ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityNotebookTopics", "$ref":"#/components/schemas/ApiEntityNotebookTopics", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"notebookTopic-post", "x-filename-id":"notebooktopic-post" } }, "/notebookTopic/batch":{ "put":{ "tags":[ "Notebook Topics" ], "summary":"Batch Update Notebook Topics", "description":"Send a request to this endpoint to update one or more notebook topic.", "operationId":"/notebookTopic/batch_updateBatch_24", "requestBody":{ "description":"One or more notebook topic objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicsInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Notebook_Topics_using_Notebook_Topic_IDs":{ "summary":"Batch Update Notebook Topics using Notebook Topic IDs", "description":"Payload to update one or more notebook topics using notebook topic IDs and notebook topic names.", "value":[ { "notebookTopicId":154404, "notebookTopicName":"Note-1" }, { "notebookTopicId":154405, "notebookTopicName":"Note-2" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"notebookTopic-batch-put", "x-filename-id":"notebooktopic-batch-put" }, "post":{ "tags":[ "Notebook Topics" ], "summary":"Batch Create Notebook Topics", "description":"Send a request to this endpoint to create one or more notebook topic.", "operationId":"/notebookTopic/batch_createBatch_25", "requestBody":{ "description":"One or more notebook topic objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicsInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Notebook_Topics_using_Workspace_IDs":{ "summary":"Batch Create Notebook Topics using Workspace IDs", "description":"Payload to create one or more notebook topics using the notebook topic names, workspace IDs, and notebook topics that apply for the objects.", "value":[ { "workspaceCode":"Ananth Construction", "notebookTopicName":"Note-1", "appliesTo":[ "ACTIVITY", "WBS", "PROJECT" ] }, { "workspaceCode":"Ananth Construction BNG", "notebookTopicName":"Note-2", "appliesTo":[ "ACTIVITY", "WBS", "PROJECT" ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopics", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"notebookTopic-batch-post", "x-filename-id":"notebooktopic-batch-post" }, "delete":{ "tags":[ "Notebook Topics" ], "summary":"Batch Delete Notebook Topics", "description":"Send a request to this endpoint to delete one or more notebook topic.", "operationId":"/notebookTopic/batch_deleteBatch_26", "requestBody":{ "description":"The system-generated identifiers of a notebook topic.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Units of Measure service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"notebookTopic-batch-delete", "x-filename-id":"notebooktopic-batch-delete" } }, "/notebookTopic/{notebookTopicId}":{ "get":{ "tags":[ "Notebook Topics" ], "summary":"View a Notebook Topic ", "description":"This endpoint returns notebook topic that the value of the {notebookTopicId} path parameter.", "operationId":"/notebookTopic/{notebookTopicId}_find_40", "parameters":[ { "name":"notebookTopicId", "in":"path", "description":"The system-generated identifier of a notebook topic.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityNotebookTopics", "$ref":"#/components/schemas/ApiEntityNotebookTopics", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"notebookTopic-{notebookTopicId}-get", "x-filename-id":"notebooktopic-notebooktopicid-get" }, "delete":{ "tags":[ "Notebook Topics" ], "summary":"Delete a Notebook Topic", "description":"Send a request to this endpoint to delete a notebook topic. The application object with an ID value that matches the value of the {notebookTopicId} path parameter will be deleted.", "operationId":"/notebookTopic/{notebookTopicId}_delete_29", "parameters":[ { "name":"notebookTopicId", "in":"path", "description":"The system-generated identifier of a notebook topic.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"notebookTopic-{notebookTopicId}-delete", "x-filename-id":"notebooktopic-notebooktopicid-delete" } }, "/notebookTopic/name/{notebookTopicName}":{ "get":{ "tags":[ "Notebook Topics" ], "summary":"View all Notebook Topics by Name", "description":"This endpoint returns notebook topic that matches the value of the {notebookTopicName} path parameter.", "operationId":"/notebookTopic/name/{notebookTopicName}_findByName_7", "parameters":[ { "name":"notebookTopicName", "in":"path", "description":"The name of a notebook topic.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopics", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"notebookTopic-name-{notebookTopicName}-get", "x-filename-id":"notebooktopic-name-notebooktopicname-get" } }, "/notebookTopic/workspace/{workspaceId}":{ "get":{ "tags":[ "Notebook Topics" ], "summary":"View all Notebook Topics by Workspace", "description":"This endpoint returns notebook topic that is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.", "operationId":"/notebookTopic/workspace/{workspaceId}_getNotebookTopicssByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopics", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"notebookTopic-workspace-{workspaceId}-get", "x-filename-id":"notebooktopic-workspace-workspaceid-get" } }, "/notebookTopic/appliesTo":{ "delete":{ "tags":[ "Notebook Topics" ], "summary":"Remove Applied Objects From Notebook Topics", "description":"Send a request to this endpoint to remove the applied business objects from notebook topics which was a part of 'appliesTo' payload in create or update request. One can remove the object only if a notebook topic is not assigned to any of the applied object. ", "operationId":"/notebookTopic/appliesTo_removeAppliesTo", "requestBody":{ "description":"One of more notebook topic applies to removal objects.# Office RESOURCE", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicsRemoveAppliesToInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Units of Measure service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"notebookTopic-appliesTo-delete", "x-filename-id":"notebooktopic-appliesto-delete" } }, "/notebookTopic/syncBatch":{ "post":{ "tags":[ "Notebook Topics" ], "summary":"Batch Sync Notebook Topics", "description":"Send a request to this endpoint to create or update one or more notebook topic.", "operationId":"/notebookTopic/syncBatch_syncBatch_25", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any notebook topic sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more notebook topic objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicsInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Notebook_Topics":{ "summary":"Create or Update Notebook Topics", "description":"Payload to create or update one or more notebook topics using the notebook topic name, notebook topic ID, workspace IDs, and notebook topics that apply for the objects.", "value":[ { "workspaceId":2, "notebookTopicName":"Note-2", "appliesTo":[ "ACTIVITY", "WBS", "PROJECT" ] }, { "notebookTopicId":154404, "notebookTopicName":"Note-1" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"notebookTopic-syncBatch-post", "x-filename-id":"notebooktopic-syncbatch-post" } }, "/action/download/job/{jobId}":{ "get":{ "tags":[ "P6 Import Export" ], "summary":"Download a P6 XML/XER", "description":"Send a request to this endpoint to download a P6 XML/XER file once the Export P6 XML/XER job has completed. The XML/XER file will be encoded based on the query parameter. Send a request to the View Job Status endpoint to monitor the Export P6 XML/XER job status.", "operationId":"/action/download/job/{jobId}_download", "parameters":[ { "name":"jobId", "in":"path", "description":"The jobId field value returned as part of the Export P6 XML/XER endpoint response.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"doEncode", "in":"query", "description":"Optional query parameter whether or not to encode the XML/XER file. Default value is 'false'.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "400":{ "description":"Invalid input for the Action service." }, "200":{ "description":"Successful operation", "content":{ "application/xml":{ "schema":{ "type":"object", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-download-job-{jobId}-get", "x-filename-id":"action-download-job-jobid-get" } }, "/action/exportP6xer":{ "post":{ "tags":[ "P6 Import Export" ], "summary":"Export a P6 XER", "description":"Send a request to this endpoint to trigger a job to export data in P6 XER format. Send a request to the View Job Status endpoint to monitor the job status. Once the job has completed, the corresponding P6 XER file can be downloaded using the Download P6 XML/XER endpoint.", "operationId":"/action/exportP6xer_scheduleExportP6XER", "parameters":[ { "name":"prefLang", "in":"query", "description":"Preferred language by the user.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "requestBody":{ "description":"Details of projects to be exported.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExportP6XMLInput", "$ref":"#/components/schemas/ApiEntityExportP6XMLInput", "exampleSetFlag":false }, "examples":{ "Export_a_P6_XER":{ "summary":"Export a P6 XER File", "description":"Export a P6 XER file using the workspace code and project information, such as project ID, project code, or project name.", "value":{ "workspaceCode":"Civil_Lines_Project", "projectsInfo":[ { "projectCode":"JamesStreet", "projectId":204101, "projectName":"James Street" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityJobDetail", "$ref":"#/components/schemas/ApiEntityJobDetail", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-exportP6xer-post", "x-filename-id":"action-exportp6xer-post" } }, "/action/exportP6xml":{ "post":{ "tags":[ "P6 Import Export" ], "summary":"Export a P6 XML", "description":"Send a request to this endpoint to trigger a job to export data in P6 XML format. Send a request to the View Job Status endpoint to monitor the job status. Once the job has completed, the corresponding P6 XML file can be downloaded using the Download P6 XML/XER endpoint.", "operationId":"/action/exportP6xml_scheduleExportP6XML", "requestBody":{ "description":"Details of projects to be exported.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExportP6XMLInput", "$ref":"#/components/schemas/ApiEntityExportP6XMLInput", "exampleSetFlag":false }, "examples":{ "Export_a_P6_XML":{ "summary":"Export a P6 XML File", "description":"Export a P6 XML file using the workspace code and project information, such as project code, project ID, and project name.", "value":{ "workspaceCode":"Civil_Lines_Project", "projectsInfo":[ { "projectCode":"JamesStreet", "projectId":204101, "projectName":"James Street" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityJobDetail", "$ref":"#/components/schemas/ApiEntityJobDetail", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-exportP6xml-post", "x-filename-id":"action-exportp6xml-post" } }, "/action/importP6xml":{ "post":{ "tags":[ "P6 Import Export" ], "summary":"Import a P6 XML", "description":"Send a request to this endpoint to create a job to import a well-formed, compressed, and encoded (Base64) P6 XML file. Send a request to the View Job Status endpoint to monitor the job status.", "operationId":"/action/importP6xml_uploadFileWithData", "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "required":[ "data", "file" ], "type":"object", "properties":{ "file":{ "type":"object", "description":"The xml file to be imported.", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object" } }, "data":{ "description":"Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XML.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityImportP6XMLInput" } ] } }, "exampleSetFlag":false, "types":[ "object" ] }, "exampleSetFlag":false } } }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityJobDetail", "$ref":"#/components/schemas/ApiEntityJobDetail", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-importP6xml-post", "x-filename-id":"action-importp6xml-post" } }, "/action/importDecodedP6xml":{ "post":{ "tags":[ "P6 Import Export" ], "summary":"Import a Decoded P6 XML", "description":"Send a request to this endpoint to create a job to import a well-formed, compressed, and decoded P6 XML file. Send a request to the View Job Status endpoint to monitor the job status.", "operationId":"/action/importDecodedP6xml_uploadFileWithDecodedData", "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "required":[ "data", "file" ], "type":"object", "properties":{ "file":{ "type":"object", "description":"The xml file to be imported.", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object" } }, "data":{ "description":"Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XML.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityImportP6XMLInput" } ] } }, "exampleSetFlag":false, "types":[ "object" ] }, "exampleSetFlag":false } } }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityJobDetail", "$ref":"#/components/schemas/ApiEntityJobDetail", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-importDecodedP6xml-post", "x-filename-id":"action-importdecodedp6xml-post" } }, "/action/importP6xer":{ "post":{ "tags":[ "P6 Import Export" ], "summary":"Import a P6 XER file", "description":"Send a request to this endpoint to create a job to import a well-formed P6 XER file. Send a request to the View Job Status endpoint to monitor the job status.Baseline import support is not available for XER.", "operationId":"/action/importP6xer_uploadXERFileWithData", "parameters":[ { "name":"prefLang", "in":"query", "description":"Preferred language by the user.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "required":[ "data", "file" ], "type":"object", "properties":{ "file":{ "type":"object", "description":"The compressed xer file to be imported.", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object" } }, "data":{ "description":"Entity payload or information with workspace, clobber options and projects to be imported using the given P6 XER file.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityImportP6XERInput" } ] } }, "exampleSetFlag":false, "types":[ "object" ] }, "exampleSetFlag":false } } }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityJobDetail", "$ref":"#/components/schemas/ApiEntityJobDetail", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-importP6xer-post", "x-filename-id":"action-importp6xer-post" } }, "/pbs":{ "put":{ "tags":[ "PBS" ], "summary":"Update a PBS", "description":"Send a request to this endpoint to update a PBS. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/pbs_update_28", "requestBody":{ "description":"PBS to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPBSInput", "$ref":"#/components/schemas/ApiEntityPBSInput", "exampleSetFlag":false }, "examples":{ "Update a PBS":{ "summary":"Update a PBS using PBS ID", "description":"Payload to update the PBS name and description using the PBS ID.", "value":{ "pbsId":1919002, "pbsName":"HVAC Design phase-2", "description":"HVAC Design phase-2, PBS 11" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the PBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"pbs-put", "x-filename-id":"pbs-put" }, "post":{ "tags":[ "PBS" ], "summary":"Create a PBS", "description":"Send a request to this endpoint to create a PBS. An application object will be created using the JSON data provided in the request body.", "operationId":"/pbs_create_29", "requestBody":{ "description":"PBS to be created", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPBSInput", "$ref":"#/components/schemas/ApiEntityPBSInput", "exampleSetFlag":false }, "examples":{ "Create_a_PBS":{ "summary":"Create a PBS", "description":"Payload to create PBS using the project ID, PBS name, PBS code, and description.", "value":{ "pbsCode":"PBS010", "pbsName":"Design", "description":"Design PBS 10", "projectId":1888907 }, "valueSetFlag":true }, "Create_a_PBS_Using_Codes":{ "summary":"Create a PBS Using Codes", "description":"Payload to create PBS using the project code, workspace code, PBS name, PBS code, description, and PBS code hierarchy.", "value":{ "pbsCode":"PBS011", "pbsName":"HVAC Design", "description":"HVAC Design PBS 11", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "pbsCodeHierarchy":[ "PBS010" ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the PBS service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPBS", "$ref":"#/components/schemas/ApiEntityPBS", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"pbs-post", "x-filename-id":"pbs-post" } }, "/pbs/{pbsId}":{ "get":{ "tags":[ "PBS" ], "summary":"View a PBS", "description":"This endpoint returns PBSs that meet the following requirements:
  • The object has an ID that matches the value of the {pbsId} path parameter.
", "operationId":"/pbs/{pbsId}_find_41", "parameters":[ { "name":"pbsId", "in":"path", "description":"The system-generated identifier of a PBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested PBS does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPBS", "$ref":"#/components/schemas/ApiEntityPBS", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"pbs-{pbsId}-get", "x-filename-id":"pbs-pbsid-get" }, "delete":{ "tags":[ "PBS" ], "summary":"Delete a PBS", "description":"Send a request to this endpoint to delete a PBS. The application object with an ID value that matches the value of the {pbsId} path parameter will be deleted.", "operationId":"/pbs/{pbsId}_delete_30", "parameters":[ { "name":"pbsId", "in":"path", "description":"ID of the PBS to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the PBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"pbs-{pbsId}-delete", "x-filename-id":"pbs-pbsid-delete" } }, "/pbs/children/{pbsId}":{ "get":{ "tags":[ "PBS" ], "summary":"View a Child in a PBS Hierarchy", "description":"This endpoint returns children of PBSs that meet the following requirements:
  • The object has an ID that matches the value of the {pbsId} path parameter.
", "operationId":"/pbs/children/{pbsId}_findChildren", "parameters":[ { "name":"pbsId", "in":"path", "description":"ID of the PBS whose children have to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested PBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"pbs-children-{pbsId}-get", "x-filename-id":"pbs-children-pbsid-get" }, "delete":{ "tags":[ "PBS" ], "summary":"Delete all Children in a PBS Hierarchy", "description":"Send a request to this endpoint to delete all children in the PBS hierarchy of a PBS with an ID value that matches the value of the {pbsId} path parameter.", "operationId":"/pbs/children/{pbsId}_deleteChildren", "parameters":[ { "name":"pbsId", "in":"path", "description":"ID of the PBS whose children have to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input for the PBS service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"pbs-children-{pbsId}-delete", "x-filename-id":"pbs-children-pbsid-delete" } }, "/pbs/project/{projectId}/code/{pbsCode}":{ "get":{ "tags":[ "PBS" ], "summary":"View a PBS by Code and Project", "description":"This endpoint returns PBSs that meet the following requirements:
  • The object has a code that matches the value of the {pbsCode} path parameter.
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/pbs/project/{projectId}/code/{pbsCode}_findByCode_8", "parameters":[ { "name":"projectId", "in":"path", "description":"Project ID of the PBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"pbsCode", "in":"path", "description":"PBS code of the PBS to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested PBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"pbs-project-{projectId}-code-{pbsCode}-get", "x-filename-id":"pbs-project-projectid-code-pbscode-get" } }, "/pbs/project/{projectId}/name/{pbsName}":{ "get":{ "tags":[ "PBS" ], "summary":"View a PBS by Name and Project", "description":"This endpoint returns PBSs that meet the following requirements:
  • The object has a name that matches the value of the {pbsName} path parameter.
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/pbs/project/{projectId}/name/{pbsName}_findByName_8", "parameters":[ { "name":"projectId", "in":"path", "description":"Project ID of the PBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"pbsName", "in":"path", "description":"PBS name of the PBS to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested PBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"pbs-project-{projectId}-name-{pbsName}-get", "x-filename-id":"pbs-project-projectid-name-pbsname-get" } }, "/pbs/project/{projectId}":{ "get":{ "tags":[ "PBS" ], "summary":"View a PBS by Project", "description":"This endpoint returns PBSs that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/pbs/project/{projectId}_findByProject_10", "parameters":[ { "name":"projectId", "in":"path", "description":"Project ID of the PBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested PBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"pbs-project-{projectId}-get", "x-filename-id":"pbs-project-projectid-get" } }, "/pbs/{pbsId}/childrenHierarchy":{ "get":{ "tags":[ "PBS" ], "summary":"View All Children in a PBS Hierarchy", "description":"This endpoint returns all children of PBSs that meet the following requirements:
  • The object has an ID that matches the value of the {pbsId} path parameter.
", "operationId":"/pbs/{pbsId}/childrenHierarchy_getChildrenHierarchy_1", "parameters":[ { "name":"pbsId", "in":"path", "description":"Returns the PBS that are children in the hierarchy of the specified PBS ID.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested PBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"pbs-{pbsId}-childrenHierarchy-get", "x-filename-id":"pbs-pbsid-childrenhierarchy-get" } }, "/periodCloseoutRecord/{periodCloseOutRecordId}":{ "get":{ "tags":[ "Period Closeout Record" ], "summary":"View a Period Closeout", "description":"This endpoint returns period closeouts that meet the following requirements:
  • The object has an ID that matches the value of the {periodCloseOutRecordId} path parameter.
", "operationId":"/periodCloseoutRecord/{periodCloseOutRecordId}_find_42", "parameters":[ { "name":"periodCloseOutRecordId", "in":"path", "description":"ID of the period closeout that has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested period closeout does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPeriodCloseOutRecord", "$ref":"#/components/schemas/ApiEntityPeriodCloseOutRecord", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"periodCloseoutRecord-{periodCloseOutRecordId}-get", "x-filename-id":"periodcloseoutrecord-periodcloseoutrecordid-get" } }, "/periodCloseoutRecord/project/{projectId}":{ "get":{ "tags":[ "Period Closeout Record" ], "summary":"View all Period Closeout by Project", "description":"This endpoint returns period closeouts that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/periodCloseoutRecord/project/{projectId}_findByProjectId_2", "parameters":[ { "name":"projectId", "in":"path", "description":"ID of the project for which period closeout has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested period closeout does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPeriodCloseOutRecord", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"periodCloseoutRecord-project-{projectId}-get", "x-filename-id":"periodcloseoutrecord-project-projectid-get" } }, "/program/assignUser":{ "post":{ "tags":[ "Program" ], "summary":"Assign Permission Profiles To User", "description":"Send a request to this endpoint to view the user's permission sets for the provided program.", "operationId":"/program/assignUser_assignUser_4", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail to successfully complete the request if an error occurred when validating any user permission profile sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with program and user profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramUserPermissions", "$ref":"#/components/schemas/ApiEntityProgramUserPermissions", "exampleSetFlag":false }, "examples":{ "Assign_Program_Permission_Profiles_to_Multiple_Users_Using_IDs":{ "summary":"Assign Program Permission Profiles to Multiple Users Using IDs", "description":"Payload to assign program permission to multiple Users using mandatory fields such as program ID, user name, and program profile ID.", "value":{ "programId":348001, "profiles":[ { "userName":"manager@example.com", "programProfileId":"8101" }, { "userName":"supervisor@example.com", "programProfileId":"8101" } ] }, "valueSetFlag":true }, "Assign_Program_Permission_Profiles_to_Multiple_Users_Using_Codes":{ "summary":"Assign Program Permission Profiles to Multiple Users Using Codes", "description":"Payload to assign program permission to multiple users using program code, workspace Id, profiles such as user name, program profile ID, file profile ID, report profile ID, and customLog profile ID.", "value":{ "programCode":"Juniper Program", "workspaceId":1098902, "profiles":[ { "userName":"supervisor@example.com", "programProfileId":"8101", "fileProfileId":"6", "reportProfileId":"7", "customLogProfileId":"9" }, { "userName":"manager@example.com", "programProfileId":"8101", "fileProfileId":"6", "reportProfileId":"7", "customLogProfileId":"9" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityProgramUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"program-assignUser-post", "x-filename-id":"program-assignuser-post" } }, "/program":{ "put":{ "tags":[ "Program" ], "summary":"Update a Program", "description":"Send a request to this endpoint to update a program. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/program_update_29", "requestBody":{ "description":"A program object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramInput", "$ref":"#/components/schemas/ApiEntityProgramInput", "exampleSetFlag":false }, "examples":{ "Update_a_Program_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Program to Assign a Boolean Configured Field", "description":"Payload to update the program using the program ID and configured field column label and text value.", "value":{ "programId":1076801, "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Program":{ "summary":"Update a Program", "description":"Payload to update the program name of a program using the program code, program name, and workspace ID.", "value":{ "programCode":"Juniper Program", "programName":"Juniper Program - Asia", "workspaceId":1539201 }, "valueSetFlag":true }, "Update_a_Program_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Program by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the program using the program ID and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "programId":1076801, "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Update_a_Program_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Program by Assigning Multiple Code Values Using IDs", "description":"Payload to update the program using the program ID and codeValues fields such as code value ID and code type ID.", "value":{ "programId":1076801, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Update_a_Program_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Program by Assigning Code Values Using Codes", "description":"Payload to update the program using the program code, workspace code, and codeValues fields such as code value code and code type code.", "value":{ "programCode":"Juniper Program", "workspaceCode":"Asia", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_Program_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Program by Assigning Code Values Using IDs", "description":"Payload to update the program using the program ID and codeValues fields such as code value ID and code type ID.", "value":{ "programId":1076801, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Program_by_Removing_a_Configured_Field":{ "summary":"Update a Program by Removing a Configured Field", "description":"Payload to update the program using the program ID and specifying the action and column label for the configured field to be removed.", "value":{ "programId":1076801, "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"program-put", "x-filename-id":"program-put" }, "post":{ "tags":[ "Program" ], "summary":"Create a Program", "description":"Send a request to this endpoint to create a program. An application object will be created using the JSON data provided in the request body.", "operationId":"/program_create_30", "requestBody":{ "description":"A program object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramInput", "$ref":"#/components/schemas/ApiEntityProgramInput", "exampleSetFlag":false }, "examples":{ "Create_a_Program_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Program by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a program using the program code, program name, and workspace code, and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceCode":"Asia", "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Create_a_Program_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create a Program by Assigning Code Values Using IDs", "description":"Payload to create a program using the program code, program name, and workspace code, and codeValues fields such as code value ID and code type ID.", "value":{ "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceCode":"Asia", "codeValues":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Create_a_Program_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Program by Assigning Multiple Code Values Using IDs", "description":"Payload to create a program using the program code, program name, and workspace code, and codeValues fields such as code value ID and code type ID.", "value":{ "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceCode":"Asia", "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Program_that_includes_Configured_Field_Text":{ "summary":"Create a Program that includes Configured Field Text", "description":"Payload to create a program using the program code, program name, workspace ID, and values for the configured field which include column name and text value.", "value":{ "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceId":1539201, "configuredFields":[ { "columnName":"Notes", "textValue":"Program Notes" } ] }, "valueSetFlag":true }, "Create_a_Program":{ "summary":"Create a Program", "description":"Payload to create a program using the program code, program name, and workspace ID.", "value":{ "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceId":1539201 }, "valueSetFlag":true }, "Create_a_Program_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Program that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a program using the program code, program name, workspace ID, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceId":1539201, "configuredFields":[ { "columnName":"Notes", "textValue":"Program Notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Program_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Program by Assigning Code Values Using Codes", "description":"Payload to create a program using the program code, program name, and workspace code, and codeValues fields such as code value code and code type code.", "value":{ "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceCode":"Asia", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramResponse", "$ref":"#/components/schemas/ApiEntityProgramResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"program-post", "x-filename-id":"program-post" } }, "/program/batch":{ "put":{ "tags":[ "Program" ], "summary":"Batch Update Programs", "description":"Send a request to this endpoint to update one or more programs. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/program/batch_updateBatch_25", "requestBody":{ "description":"One or more program objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Programs_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Programs by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the programs using the program ID and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "programId":436446 }, { "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "programId":436447 } ], "valueSetFlag":true }, "Batch_Update_Programs_to_Assign_Configured_Field":{ "summary":"Batch Update Programs to Assign Configured Field", "description":"Payload to update the programs using the program ID and configured field column name, column label, column definition ID, and text value.", "value":[ { "configuredFields":[ { "columnName":"Notes", "textValue":"Program Notes" }, { "columnDefinationId":60045, "textValue":"N" } ], "programId":436446 }, { "configuredFields":[ { "columnName":"Notes", "textValue":"Program Notes" }, { "columnDefinationId":60045, "textValue":"N" } ], "programId":436447 } ], "valueSetFlag":true }, "Batch_Update_Programs_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Programs by Assigning Code Values Using Codes or IDs", "description":"Payload to update the programs using the program ID and codeValues fields such as code value code and code type code.", "value":[ { "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "programId":436446 }, { "codeValues":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "programId":436447 } ], "valueSetFlag":true }, "Batch_Update_Programs":{ "summary":"Batch Update Programs", "description":"Payload to update the program name of one or more programs using the program codes, program names, and workspace IDs.", "value":[ { "programCode":"Juniper Program", "programName":"Juniper Program - Asia", "workspaceId":1539201 }, { "programCode":"Enterprise Initiative", "programName":"Enterprise Initiative - Asia", "workspaceId":1539201 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"program-batch-put", "x-filename-id":"program-batch-put" }, "post":{ "tags":[ "Program" ], "summary":"Batch Create Programs", "description":"Send a request to this endpoint to create one or more programs. An application object will be created for each JSON object provided in the request body.", "operationId":"/program/batch_createBatch_26", "requestBody":{ "description":"One or more program objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Programs":{ "summary":"Batch Create Programs", "description":"Payload to create one or more programs using the program codes, program names, and workspace IDs.", "value":[ { "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceId":1539201 }, { "programCode":"Enterprise Initiative", "programName":"Enterprise Initiative", "workspaceId":1539201 } ], "valueSetFlag":true }, "Batch_Create_Programs_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Programs by Assigning Code Values Using Codes", "description":"Payload to create programs using the program code, program name, and workspace code, and codeValues fields such as code value code and code type code.", "value":[ { "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceCode":"Asia", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ] }, { "programCode":"Enterprise Initiative", "programName":"Enterprise Initiative", "workspaceCode":"Asia", "codeValues":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ] } ], "valueSetFlag":true }, "Batch_Create_Programs_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Programs by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create programs using the program code, program name, and workspace code, and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceCode":"Asia", "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, { "programCode":"Enterprise Initiative", "programName":"Enterprise Initiative", "workspaceCode":"Asia", "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] } ], "valueSetFlag":true }, "Batch_Create_Programs_that_include_Configured_Field_Text":{ "summary":"Batch Create Programs that include Configured Field Text", "description":"Payload to create one or more programs using the program codes, program names, workspace IDs and values for the configured field which include column name, column definition ID, text value.", "value":[ { "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceId":1539201, "configuredFields":[ { "columnName":"Notes", "textValue":"Program Notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "programCode":"Enterprise Initiative", "programName":"Enterprise Initiative", "workspaceId":1539201, "configuredFields":[ { "columnName":"Notes", "textValue":"Program Notes" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-batch-post", "x-filename-id":"program-batch-post" }, "delete":{ "tags":[ "Program" ], "summary":"Batch Delete Programs", "description":"Send a request to this endpoint to delete one or more programs. Objects with ID values that match the values provided in the request body will be deleted. ", "operationId":"/program/batch_deleteBatch_27", "requestBody":{ "description":"IDs of the programs to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"program-batch-delete", "x-filename-id":"program-batch-delete" } }, "/program/{programId}":{ "get":{ "tags":[ "Program" ], "summary":"View a Program", "description":"This endpoint returns programs that meet the following requirements:
  • The object is associated with a program with an ID value that matches the value of the {programId} path parameter.
", "operationId":"/program/{programId}_find_43", "parameters":[ { "name":"programId", "in":"path", "description":"ID of the program to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgram", "$ref":"#/components/schemas/ApiEntityProgram", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "404":{ "description":"The requested program does not exist, or you do not have access to it." } }, "x-internal-id":"program-{programId}-get", "x-filename-id":"program-programid-get" }, "delete":{ "tags":[ "Program" ], "summary":"Delete a Program", "description":"Send a request to this endpoint to delete a program. The application object with an ID value that matches the value of the {programId} path parameter will be deleted.", "operationId":"/program/{programId}_delete_31", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"program-{programId}-delete", "x-filename-id":"program-programid-delete" } }, "/program/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Program" ], "summary":"View all Programs by Assigned Code Value", "description":"This endpoint returns programs that meet the following requirements:
  • The object is assigned a code type that matches the value of the {codeTypeId} path parameter and a code value that matches the value of the {codeValueCode} path parameter.
", "operationId":"/program/codeType/{codeTypeId}/codeValue/{codeValueCode}_findByCodeTypeIdAndCodeValueCode", "parameters":[ { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"program-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/program/portfolio/{portfolioId}":{ "get":{ "tags":[ "Program" ], "summary":"View all Programs by Portfolio ID", "description":"This endpoint returns programs that meet the following requirements:
  • The object is associated with a portfolio with an ID value that matches the value of the {portfolioId} path parameter.
", "operationId":"/program/portfolio/{portfolioId}_findByPortfolioId", "parameters":[ { "name":"portfolioId", "in":"path", "description":"The system-generated unique identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-portfolio-{portfolioId}-get", "x-filename-id":"program-portfolio-portfolioid-get" } }, "/program/portfolio/name/{portfolioName}":{ "get":{ "tags":[ "Program" ], "summary":"View all Programs by Portfolio Name", "description":"This endpoint returns programs that meet the following requirements:
  • The object is associated with a portfolio with a name that matches the value of the {portfolioName} path parameter.
", "operationId":"/program/portfolio/name/{portfolioName}_findByPortfolioName", "parameters":[ { "name":"portfolioName", "in":"path", "description":"The user-specified unique identifier of a portfolio.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-portfolio-name-{portfolioName}-get", "x-filename-id":"program-portfolio-name-portfolioname-get" } }, "/program/code/{programCode}":{ "get":{ "tags":[ "Program" ], "summary":"View all Programs by Program Code", "description":"This endpoint returns programs that meet the following requirements:
  • The object has a code that matches the value of the {programCode} path parameter.
", "operationId":"/program/code/{programCode}_findByProgramCode", "parameters":[ { "name":"programCode", "in":"path", "description":"The user-specified identifier of the program to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-code-{programCode}-get", "x-filename-id":"program-code-programcode-get" } }, "/program/byItemCode":{ "get":{ "tags":[ "Program" ], "summary":"View a Program by Code and Workspace Code", "description":"Send a request to this endpoint to view a program with codes matching the code fields in query parameters.", "operationId":"/program/byItemCode_findByProgramCodeAndWorkspaceCode", "parameters":[ { "name":"programCode", "in":"query", "description":"The user-specified identifier of the program to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"Workspace Code of the program to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgram", "$ref":"#/components/schemas/ApiEntityProgram", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "404":{ "description":"The requested program does not exist, or you do not have access to it." } }, "x-internal-id":"program-byItemCode-get", "x-filename-id":"program-byitemcode-get" } }, "/program/name/{programName}":{ "get":{ "tags":[ "Program" ], "summary":"View all Programs by Name", "description":"This endpoint returns programs that meet the following requirements:
  • The object has a name that matches the value of the {programName} path parameter.
", "operationId":"/program/name/{programName}_findByProgramName", "parameters":[ { "name":"programName", "in":"path", "description":"Name of the program to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-name-{programName}-get", "x-filename-id":"program-name-programname-get" } }, "/program/project/{projectId}":{ "get":{ "tags":[ "Program" ], "summary":"View all Programs by Project", "description":"This endpoint returns programs that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/program/project/{projectId}_findByProjectId_3", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-project-{projectId}-get", "x-filename-id":"program-project-projectid-get" } }, "/program/workspace/{workspaceId}":{ "get":{ "tags":[ "Program" ], "summary":"View all Programs by Workspace", "description":"This endpoint returns programs that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/program/workspace/{workspaceId}_findByWorkspaceId_2", "parameters":[ { "name":"workspaceId", "in":"path", "description":"Workspace ID of the program to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-workspace-{workspaceId}-get", "x-filename-id":"program-workspace-workspaceid-get" } }, "/program/financialsAndSettings/project/{projectId}":{ "get":{ "tags":[ "Program" ], "summary":"View all Program Financial and Settings by Project", "description":"Send a request to this endpoint to view all program financial and settings with an ID value matching the value of the {projectId} path parameter", "operationId":"/program/financialsAndSettings/project/{projectId}_findFinancialsByPortfolioId", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramFinancialAndSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-financialsAndSettings-project-{projectId}-get", "x-filename-id":"program-financialsandsettings-project-projectid-get" } }, "/program/financialsAndSettings/portfolio/{portfolioId}":{ "get":{ "tags":[ "Program" ], "summary":"View all Program Financial and Settings by Portfolio", "description":"Send a request to this endpoint to view all program financial and settings with an ID value matching the value of the {portfolioId} path parameter", "operationId":"/program/financialsAndSettings/portfolio/{portfolioId}_findFinancialsByProgramId", "parameters":[ { "name":"portfolioId", "in":"path", "description":"The unique identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramFinancialAndSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-financialsAndSettings-portfolio-{portfolioId}-get", "x-filename-id":"program-financialsandsettings-portfolio-portfolioid-get" } }, "/program/financialsAndSettings/portfolio/name/{name}":{ "get":{ "tags":[ "Program" ], "summary":"View all Program Financial and Settings by Portfolio Name", "description":"Send a request to this endpoint to view all program financial and settings with a name value matching the value of the {name} path parameter", "operationId":"/program/financialsAndSettings/portfolio/name/{name}_findFinancialsByProjectId", "parameters":[ { "name":"name", "in":"path", "description":"The name of a portfolio.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramFinancialAndSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-financialsAndSettings-portfolio-name-{name}-get", "x-filename-id":"program-financialsandsettings-portfolio-name-name-get" } }, "/program/financialsAndSettings/workspace/{workspaceId}":{ "get":{ "tags":[ "Program" ], "summary":"View all Program Financial and Settings by Workspace", "description":"Send a request to this endpoint to view all program financial and settings with an ID value matching the value of the {workspaceId} path parameter", "operationId":"/program/financialsAndSettings/workspace/{workspaceId}_findFinancialsByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"Workspace ID of the program to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramFinancialAndSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-financialsAndSettings-workspace-{workspaceId}-get", "x-filename-id":"program-financialsandsettings-workspace-workspaceid-get" } }, "/program/permissionSets":{ "get":{ "tags":[ "Program" ], "summary":"View Available Permission Sets for Program", "description":"Send a request to this endpoint to view the available permission sets for the provided program.", "operationId":"/program/permissionSets_getPermissionSets_4", "parameters":[ { "name":"programId", "in":"query", "description":"ID of the program to be found.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"programCode", "in":"query", "description":"The user-specified identifier of the program to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"Workspace Code of the program to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPermissionSets", "$ref":"#/components/schemas/ApiEntityPermissionSets", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"program-permissionSets-get", "x-filename-id":"program-permissionsets-get" } }, "/program/financialsAndSettings/refreshCashflow":{ "post":{ "tags":[ "Program", "Action" ], "summary":"Refresh Program Cashflow by Program", "description":"Send a request to this endpoint to refresh the cashflow for the provided program.", "operationId":"/program/financialsAndSettings/refreshCashflow_refreshProgramCashflow", "requestBody":{ "description":"A program object.", "content":{ "application/json":{ "schema":{ "title":"ProgramIdentifier", "$ref":"#/components/schemas/ProgramIdentifier", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"program-financialsAndSettings-refreshCashflow-post", "x-filename-id":"program-financialsandsettings-refreshcashflow-post" } }, "/program/removeUsers":{ "post":{ "tags":[ "Program" ], "summary":"Remove Users Assigned to a Program", "description":"Send a request to this endpoint to remove users from a program.", "operationId":"/program/removeUsers_removeUsers_2", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user removal sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"Remove user from input.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRemoveProgramUserPermissions", "$ref":"#/components/schemas/ApiEntityRemoveProgramUserPermissions", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRemoveProgramUserPermissionsResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-removeUsers-post", "x-filename-id":"program-removeusers-post" } }, "/program/syncBatch":{ "post":{ "tags":[ "Program" ], "summary":"Batch Sync Programs", "description":"Send a request to this endpoint to create or update one or more programs. This endpoint should to be used to sync programs under a single workspace. ", "operationId":"/program/syncBatch_syncBatch_26", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any program sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more program objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Programs_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create or Update Programs by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update programs using the program code, workspace code, program name, program ID, and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceCode":"Asia" }, { "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "programId":244756 } ], "valueSetFlag":true }, "Create_or_Update_a_Programs":{ "summary":"Create or Update a Programs", "description":"Payload to create or update a program using the program code, program name, and workspace ID.", "value":[ { "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceId":1539201 } ], "valueSetFlag":true }, "Create_or_Update_Programs_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create or Update Programs by Assigning Code Values Using Codes", "description":"Payload to create or update programs using the program code, workspace code, program name, program ID, and codeValues fields such as code value code and code type code.", "value":[ { "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ], "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceCode":"Asia" }, { "codeValues":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "programId":244756 } ], "valueSetFlag":true }, "Create_or_ Update_a_Program_Using_Code_Value":{ "summary":"Create or Update a Program Using Code Value", "description":"Payload to create or update a program using the program code, program name workspace ID, code value name, code value code, and code type code.", "value":[ { "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceId":1539201, "codeValues":[ { "codeValueName":"High Value", "codeValueCode":"High Value", "codeTypeCode":"Value" } ] } ], "valueSetFlag":true }, "Create_or_Update_Programs_to_Assign_a_Configured_Field":{ "summary":"Create or Update Programs to Assign a Configured Field", "description":"Payload to create or update programs using the program code, workspace code, program name, program ID, and and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "configuredFields":[ { "columnLabel":"Notes", "textValue":"Program Notes" }, { "columnDefinationId":61045, "textValue":"N" } ], "programCode":"Juniper Program", "programName":"Juniper Program", "workspaceCode":"Asia" }, { "configuredFields":[ { "columnLabel":"Notes", "textValue":"Program Notes" }, { "columnDefinationId":60045, "numberValue":2 } ], "programId":244756 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"program-syncBatch-post", "x-filename-id":"program-syncbatch-post" } }, "/programBudget/program/{programId}/changeBudgetStatus":{ "put":{ "tags":[ "Program Budget" ], "summary":"Change a Program Budget Status", "description":"Send a request to this endpoint to update the status of a program budget that meet the following requirements:
  • The object is associated with a program with an ID value that matches the value of the {programId} path parameter.
An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/programBudget/program/{programId}/changeBudgetStatus_changeBudgetStatus", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"Status Transition Object with new Status and userIds to be notified.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStatusTransition", "$ref":"#/components/schemas/ApiEntityStatusTransition", "exampleSetFlag":false }, "examples":{ "Change_a_Program_Budget_Status.":{ "summary":"Change a Program Budget Status.", "description":"Payload to update the status of program budget using the budget status field.", "value":{ "budgetStatus":"PENDING" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "404":{ "description":"The requested program budget does not exist, or you do not have access to it." }, "400":{ "description":"Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudget-program-{programId}-changeBudgetStatus-put", "x-filename-id":"programbudget-program-programid-changebudgetstatus-put" } }, "/programBudget":{ "post":{ "tags":[ "Program Budget" ], "summary":"Create a Program Budget", "description":"This endpoint creates a program budget with a Status value of DRAFT. If the program budget already exists, it is directly returned.", "operationId":"/programBudget_create_31", "requestBody":{ "description":"A program budget object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetInput", "$ref":"#/components/schemas/ApiEntityProgramBudgetInput", "exampleSetFlag":false }, "examples":{ "Create_a_Program_Budget.":{ "summary":"Create a Program Budget.", "description":"Payload to create a program budget using the program code and workspace ID.", "value":{ "workspaceId":1539201, "programCode":"Enterprise Initiative" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudget", "$ref":"#/components/schemas/ApiEntityProgramBudget", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-post", "x-filename-id":"programbudget-post" } }, "/programBudget/batch":{ "post":{ "tags":[ "Program Budget" ], "summary":"Batch Create Program Budgets", "description":"This endpoint creates one or more program budgets with Status values of DRAFT. If the program budgets already exist, they are directly returned.", "operationId":"/programBudget/batch_createBatch_27", "requestBody":{ "description":"One or more program budget objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Program_Budgets.":{ "summary":"Batch Create Program Budgets.", "description":"Payload to create one or more program budgets using the program codes and workspace IDs.", "value":[ { "workspaceId":1539201, "programCode":"Enterprise Initiative" }, { "workspaceId":1539201, "programCode":"Juniper Program" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudget", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-batch-post", "x-filename-id":"programbudget-batch-post" } }, "/programBudget/{programBudgetId}":{ "get":{ "tags":[ "Program Budget" ], "summary":"View a Program Budget ", "description":"This endpoint returns a program budget that meet the following requirements:
  • The object belongs to a program budget with an ID value that matches the value of the {programBudgetId} path parameter.
", "operationId":"/programBudget/{programBudgetId}_find_44", "parameters":[ { "name":"programBudgetId", "in":"path", "description":"The system-generated unique identifier of a program budget.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudget", "$ref":"#/components/schemas/ApiEntityProgramBudget", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-{programBudgetId}-get", "x-filename-id":"programbudget-programbudgetid-get" } }, "/programBudget/portfolio/name/{portfolioName}":{ "get":{ "tags":[ "Program Budget" ], "summary":"View Program Budgets by Portfolio Name", "description":"This endpoint returns program budgets that meet the following requirements:
  • The object is associated with a portfolio with a name that matches the value of the {portfolioName} path parameter.
", "operationId":"/programBudget/portfolio/name/{portfolioName}_findByPortfolioName_1", "parameters":[ { "name":"portfolioName", "in":"path", "description":"The user-specified unique identifier of a portfolio.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested portfolio does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudget", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-portfolio-name-{portfolioName}-get", "x-filename-id":"programbudget-portfolio-name-portfolioname-get" } }, "/programBudget/program/{programId}":{ "get":{ "tags":[ "Program Budget" ], "summary":"View a Program Budget by Program", "description":"This endpoint returns a program budget that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
", "operationId":"/programBudget/program/{programId}_findByProgramId", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudget", "$ref":"#/components/schemas/ApiEntityProgramBudget", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-program-{programId}-get", "x-filename-id":"programbudget-program-programid-get" } }, "/programBudget/workspace/code/{workspaceCode}":{ "get":{ "tags":[ "Program Budget" ], "summary":"View Program Budgets by Workspace Code", "description":"This endpoint returns program budgets that meet the following requirements:
  • The object is associated with a workspace with a code value that matches the value of the {workspaceCode} path parameter.
", "operationId":"/programBudget/workspace/code/{workspaceCode}_findByWorkspaceCode_1", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested workspace does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudget", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-workspace-code-{workspaceCode}-get", "x-filename-id":"programbudget-workspace-code-workspacecode-get" } }, "/programBudget/{programBudgetId}/linkedProjectTransactions":{ "get":{ "tags":[ "Program Budget" ], "summary":"View Linked Project Budget Item Transactions by Program Budget ID", "description":"This endpoint returns program budget transactions that meet the following requirements:
  • The object is associated with a program budget with an ID value that matches the value of the {programBudgetId} path parameter.
Program budget transactions capture the program budget transfers and program budget changes for program budgets.
This API returns only the transaction wherein the project budget item is either the source or destination in the transaction under a program budget.", "operationId":"/programBudget/{programBudgetId}/linkedProjectTransactions_findLinkedProjectTransactionsByProgramBudgetId", "parameters":[ { "name":"programBudgetId", "in":"path", "description":"The system-generated unique identifier of a program budget.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-{programBudgetId}-linkedProjectTransactions-get", "x-filename-id":"programbudget-programbudgetid-linkedprojecttransactions-get" } }, "/programBudget/program/{programId}/linkedProjectTransactions":{ "get":{ "tags":[ "Program Budget" ], "summary":"View Linked Project Budget Item Transactions by Program ID", "description":"This endpoint returns program budget transactions that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
Program budget transactions capture the program budget transfers and program budget changes for program budgets.
This API returns only the transaction wherein the project budget item is either the source or destination in the transaction under a program budget.", "operationId":"/programBudget/program/{programId}/linkedProjectTransactions_findLinkedProjectTransactionsByProgramId", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-program-{programId}-linkedProjectTransactions-get", "x-filename-id":"programbudget-program-programid-linkedprojecttransactions-get" } }, "/programBudget/{programBudgetId}/transactions":{ "get":{ "tags":[ "Program Budget" ], "summary":"View Program Budget Transactions By Program Budget ID", "description":"This endpoint returns program budget transactions that meet the following requirements:
  • The object is associated with a program budget with an ID value that matches the value of the {programBudgetId} path parameter.
Program budget transactions capture the program budget transfers and program budget changes for program budgets.", "operationId":"/programBudget/{programBudgetId}/transactions_findTransactionsByProgramBudgetId", "parameters":[ { "name":"programBudgetId", "in":"path", "description":"The system-generated unique identifier of a program budget.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-{programBudgetId}-transactions-get", "x-filename-id":"programbudget-programbudgetid-transactions-get" } }, "/programBudget/program/{programId}/transactions":{ "get":{ "tags":[ "Program Budget" ], "summary":"View Program Budget Transactions By Program ID", "description":"This endpoint returns program budget transactions that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
Program budget transactions capture the program budget transfers and program budget changes for program budgets. This API returns only the transactions wherein the program budget item is either the source or destination in the transaction under a program budget.", "operationId":"/programBudget/program/{programId}/transactions_findTransactionsByProgramId", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-program-{programId}-transactions-get", "x-filename-id":"programbudget-program-programid-transactions-get" } }, "/programBudget/program/{programId}/statusTransitionHistory":{ "get":{ "tags":[ "Program Budget" ], "summary":"View all Program Budget Status Transition History by Program", "description":"This endpoint returns a program budget status transition history that meet the following requirements:
  • The object is associated with a program with an ID value that matches the value of the {programId} path parameter.
", "operationId":"/programBudget/program/{programId}/statusTransitionHistory_findTransitionHistoryByProgramId", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudget-program-{programId}-statusTransitionHistory-get", "x-filename-id":"programbudget-program-programid-statustransitionhistory-get" } }, "/programBudgetChange/{programBudgetChangeId}/changeProgramBudgetChangeStatus":{ "put":{ "tags":[ "Program Budget Change" ], "summary":"Change Program Budget Change Status", "description":"Send a request to this end point to modify the status of a program budget change.", "operationId":"/programBudgetChange/{programBudgetChangeId}/changeProgramBudgetChangeStatus_changeBudgetChangeStatus_1", "parameters":[ { "name":"programBudgetChangeId", "in":"path", "description":"The system-generated identifier of a program budget change.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"A new status for the program budget change.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStatusTransition", "$ref":"#/components/schemas/ApiEntityStatusTransition", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "404":{ "description":"The requested program budget change does not exist, or you do not have access to it." }, "400":{ "description":"Invalid input for the Program Budget Change service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetChange-{programBudgetChangeId}-changeProgramBudgetChangeStatus-put", "x-filename-id":"programbudgetchange-programbudgetchangeid-changeprogrambudgetchangestatus-put" } }, "/programBudgetChange":{ "put":{ "tags":[ "Program Budget Change" ], "summary":"Update a Program Budget Change", "description":"Send a request to this endpoint to update a program budget change. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/programBudgetChange_update_30", "requestBody":{ "description":"A budget change object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetChangeInput", "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeInput", "exampleSetFlag":false }, "examples":{ "Update_a_Program_Budget_Change_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Program Budget Change to Assign a Boolean Configured Field", "description":"Payload to update the cost amount of a program budget change using the budget change ID, budget transaction ID, and configured field column label and text value.", "value":{ "programBudgetChangeId":102102, "programBudgetChangeTransactions":[ { "programBudgetTransactionId":238405, "programBudgetTransactionCost":{ "amountCostCOR":15000 } } ], "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Program_Budget_Change_Using_a_Program_Budget_Change_ID":{ "summary":"Update a Program Budget Change Using a Program Budget Change ID", "description":"Payload to update the cost amount of a program budget change using the budget change ID and budget transaction ID.", "value":{ "programBudgetChangeId":102102, "programBudgetChangeTransactions":[ { "programBudgetTransactionId":238405, "programBudgetTransactionCost":{ "amountCostCOR":15000 } } ] }, "valueSetFlag":true }, "Update_a_Program_Budget_Change_by_Removing_a_Configured_Field":{ "summary":"Update a Program Budget Change by Removing a Configured Field", "description":"Payload to update the cost amount of a program budget change using the budget change ID, budget transaction ID, and specifying the action and column label for the configured field to be removed.", "value":{ "programBudgetChangeId":102102, "programBudgetChangeTransactions":[ { "programBudgetTransactionId":238405, "programBudgetTransactionCost":{ "amountCostCOR":15000 } } ], "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Change service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetChange-put", "x-filename-id":"programbudgetchange-put" }, "post":{ "tags":[ "Program Budget Change" ], "summary":"Create a Program Budget Change", "description":"Send a request to this endpoint to create a program budget change. An application object will be created using the JSON data provided in the request body.", "operationId":"/programBudgetChange_create_32", "requestBody":{ "description":"A budget change object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetChangeInput", "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeInput", "exampleSetFlag":false }, "examples":{ "Create_a_Program_Budget_Change_Using_an_Existing_Budget_Item":{ "summary":"Create a Program Budget Change Using an Existing Budget Item", "description":"Payload to create a program budget change of an existing budget item using the budget change code, budget item ID, amount cost, program budget ID, and program ID.", "value":{ "programBudgetChangeCode":"Construction Materials Change", "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":10000 }, "programBudgetItemId":194503 } ], "programId":754504, "programBudgetId":250301 }, "valueSetFlag":true }, "Create_a_Program_Budget_Change_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Program Budget Change that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a program budget change of an existing budget item using the budget change code, budget item ID, amount cost, program ID, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "programBudgetChangeCode":"Construction Materials Change", "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":10000 }, "programBudgetItemId":194503 } ], "programId":754504, "configuredFields":[ { "columnName":"Notes", "textValue":"program Budget change Notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Program_Budget_Change_that_includes_Configured_Field_Text":{ "summary":"Create a Program Budget Change that includes Configured Field Text", "description":"Payload to create a program budget change of an existing budget item using the budget change code, budget item ID, amount cost, program ID, and values for the configured field which include column name and text value for budget transactions and budget change.", "value":{ "programBudgetChangeCode":"Construction Materials Change", "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":10000 }, "programBudgetItemId":194503, "configuredFields":[ { "columnName":"Notes-trans", "textValue":"program Budget transaction Notes" } ] } ], "programId":754504, "configuredFields":[ { "columnName":"Notes-Change", "textValue":"program Budget change Notes" } ] }, "valueSetFlag":true }, "Create_a_Program_Budget_Change_Using_a_New_Budget_Item":{ "summary":"Create a Program Budget Change Using a New Budget Item", "description":"Payload to create a program budget change of adding a new budget item using the budget change code, budget item name, desired code, amount cost, budget CBS template code ID, program budget ID, and program ID.", "value":{ "programBudgetChangeCode":"External Labor Change", "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":100000 }, "programBudgetItemName":"External Labor", "desiredCode":"External Labor", "budgetCbsTemplateCodeId":410303 } ], "programId":754504, "programBudgetId":250301 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Change service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetChange", "$ref":"#/components/schemas/ApiEntityProgramBudgetChange", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-post", "x-filename-id":"programbudgetchange-post" } }, "/programBudgetChange/batch":{ "put":{ "tags":[ "Program Budget Change" ], "summary":"Batch Update Program Budget Changes", "description":"Send a request to this endpoint to update one or more program budget changes. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/programBudgetChange/batch_updateBatch_26", "requestBody":{ "description":"One or more budget change objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Program_Budget_Changes_Using_the_Program_Budget_Change_IDs":{ "summary":"Batch Update Program Budget Changes Using the Program Budget Change IDs", "description":"Payload to update the cost amount of one or more program budget changes using the budget change IDs and budget transaction IDs.", "value":[ { "programBudgetChangeId":102102, "programBudgetChangeTransactions":[ { "programBudgetTransactionId":238405, "programBudgetTransactionCost":{ "amountCostCOR":15000 } } ] }, { "programBudgetChangeId":102103, "programBudgetChangeTransactions":[ { "programBudgetTransactionId":238406, "programBudgetTransactionCost":{ "amountCostCOR":25000 } } ] } ], "valueSetFlag":true }, "Batch_Update_Program_Budget_Changes_to_Assign_Configured_Field":{ "summary":"Batch Update Program Budget Changes to Assign Configured Field", "description":"Payload to update the cost amount of one or more program budget changes using the budget change IDs, budget transaction IDs, and configured field column name, column label, column definition ID, and text value.", "value":[ { "programBudgetChangeId":102102, "programBudgetChangeTransactions":[ { "programBudgetTransactionId":238405, "programBudgetTransactionCost":{ "amountCostCOR":15000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"program Budget change Notes - Budg1" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "programBudgetChangeId":102103, "programBudgetChangeTransactions":[ { "programBudgetTransactionId":238406, "programBudgetTransactionCost":{ "amountCostCOR":25000 } } ], "configuredFields":[ { "columnName":"Notes", "textValue":"program Budget change Notes - Budg2" }, { "columnDefinationId":60045, "textValue":"N" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Change service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"programBudgetChange-batch-put", "x-filename-id":"programbudgetchange-batch-put" }, "post":{ "tags":[ "Program Budget Change" ], "summary":"Batch Create Program Budget Changes", "description":"Send a request to this endpoint to create one or more program budget changes. An application object will be created for each JSON object provided in the request body.", "operationId":"/programBudgetChange/batch_createBatch_28", "requestBody":{ "description":"One or more budget change objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Program_Budget_Changes":{ "summary":"Batch Create Program Budget Changes", "description":"Payload to create one or more program budget changes using the budget change codes, budget item IDs, cost amounts, program budget IDs, and program IDs.", "value":[ { "programBudgetChangeCode":"Construction Materials Change", "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":10000 }, "programBudgetItemId":194503 } ], "programId":754504, "programBudgetId":250301 }, { "programBudgetChangeCode":"Internal Labor Change", "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":20000 }, "programBudgetItemId":194502 } ], "programId":754504, "programBudgetId":250301 } ], "valueSetFlag":true }, "Batch_Create_Program_Budget_Changes_that_include_Configured_Field_Text":{ "summary":"Batch Create Program Budget Changes that include Configured Field Text", "description":"Payload to create one or more program budget changes using the budget change codes, budget item IDs, cost amounts, program IDs, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "programBudgetChangeCode":"Construction Materials Change", "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":10000 }, "programBudgetItemId":194503 } ], "configuredFields":[ { "columnName":"Notes", "textValue":"program Budget change Notes - Budg1" }, { "columnDefinationId":60045, "textValue":"N" } ], "programId":754504 }, { "programBudgetChangeCode":"Internal Labor Change", "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":20000 }, "programBudgetItemId":194502 } ], "configuredFields":[ { "columnName":"Notes", "textValue":"program Budget change Notes - Budg2" }, { "columnDefinationId":60045, "textValue":"Y" } ], "programId":754504 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Change service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-batch-post", "x-filename-id":"programbudgetchange-batch-post" }, "delete":{ "tags":[ "Program Budget Change" ], "summary":"Batch Delete Program Budget Changes", "description":"Send a request to this endpoint to delete one or more program budget changes. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/programBudgetChange/batch_deleteBatch_28", "requestBody":{ "description":"One or more system-generated identifiers of budget changes.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Change service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetChange-batch-delete", "x-filename-id":"programbudgetchange-batch-delete" } }, "/programBudgetChange/{programBudgetChangeId}":{ "get":{ "tags":[ "Program Budget Change" ], "summary":"View a Program Budget Change", "description":"This endpoint returns program budget changes that meet the following requirements:
  • The object is associated with a program budget change with an ID value that matches the value of the {programBudgetChangeId} path parameter.
Program Budget changes represent modifications or adjustments to program budgets.", "operationId":"/programBudgetChange/{programBudgetChangeId}_find_45", "parameters":[ { "name":"programBudgetChangeId", "in":"path", "description":"The system-generated identifier of a program budget change.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget change does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetChange", "$ref":"#/components/schemas/ApiEntityProgramBudgetChange", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-{programBudgetChangeId}-get", "x-filename-id":"programbudgetchange-programbudgetchangeid-get" }, "delete":{ "tags":[ "Program Budget Change" ], "summary":"Delete a Program Budget Change", "description":"Send a request to this endpoint to delete a program budget change. The application object with an ID value that matches the value of the {programBudgetChangeId} path parameter will be deleted.", "operationId":"/programBudgetChange/{programBudgetChangeId}_delete_32", "parameters":[ { "name":"programBudgetChangeId", "in":"path", "description":"The system-generated identifier of a program budget change.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget change does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetChange-{programBudgetChangeId}-delete", "x-filename-id":"programbudgetchange-programbudgetchangeid-delete" } }, "/programBudgetChange/{programBudgetChangeId}/statusTransitionHistory":{ "get":{ "tags":[ "Program Budget Change" ], "summary":"View Program Budget Change Status Transition History Records by Program Budget Change", "description":"This endpoint returns status transition history records of a program budget change that meet the following requirements:
  • The object is associated with a program budget change with an ID value that matches the value of the {programBudgetChangeId} path parameter.
Program Budget changes represent modifications or adjustments to program budgets.", "operationId":"/programBudgetChange/{programBudgetChangeId}/statusTransitionHistory_findTransitionHistoryByBudgetChangeId_1", "parameters":[ { "name":"programBudgetChangeId", "in":"path", "description":"The system-generated identifier of a program budget change.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested status transition history record does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-{programBudgetChangeId}-statusTransitionHistory-get", "x-filename-id":"programbudgetchange-programbudgetchangeid-statustransitionhistory-get" } }, "/programBudgetChange/program/{programId}/statusTransitionHistory":{ "get":{ "tags":[ "Program Budget Change" ], "summary":"View Program Budget Change Status Transition History Records by Program", "description":"This endpoint returns status transition history records of program budget changes that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
Program Budget changes represent modifications or adjustments to program budgets.", "operationId":"/programBudgetChange/program/{programId}/statusTransitionHistory_findTransitionHistoryByProjectId_2", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested status transition history record does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-program-{programId}-statusTransitionHistory-get", "x-filename-id":"programbudgetchange-program-programid-statustransitionhistory-get" } }, "/programBudgetChange/byParent":{ "get":{ "tags":[ "Program Budget Change" ], "summary":"View Program Budget Changes by Parent", "description":"Send a request to this end point to view all program budget changes under parent with codes matching the code fields in query parameters.", "operationId":"/programBudgetChange/byParent_getAllBudgetChangeByCode_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the program budget changes have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"Program code under which all the program budget changes have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-byParent-get", "x-filename-id":"programbudgetchange-byparent-get" } }, "/programBudgetChange/byItemCode":{ "get":{ "tags":[ "Program Budget Change" ], "summary":"View a Program Budget Change by Code and Parent Codes", "description":"Send a request to this end point to view a program budget change with codes matching the code fields in query parameters.", "operationId":"/programBudgetChange/byItemCode_getBudgetChangeByCode_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the program budget change to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"PARAM_PROGRAM_BUDGET_CHANGE_FIND.PROJECT_CODE
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programBudgetChangeCode", "in":"query", "description":"The user-specified generated identifier of a program budget change.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetChange", "$ref":"#/components/schemas/ApiEntityProgramBudgetChange", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-byItemCode-get", "x-filename-id":"programbudgetchange-byitemcode-get" } }, "/programBudgetChange/program/{programId}":{ "get":{ "tags":[ "Program Budget Change" ], "summary":"View Program Budget Changes by Program", "description":"This endpoint returns program budget changes that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
Program Budget changes represent modifications or adjustments to program budgets.", "operationId":"/programBudgetChange/program/{programId}_getBudgetChangesByProject_1", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget change does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-program-{programId}-get", "x-filename-id":"programbudgetchange-program-programid-get" } }, "/programBudgetChange/programBudget/{programBudgetId}":{ "get":{ "tags":[ "Program Budget Change" ], "summary":"View Program Budget Changes by Program Budget", "description":"This endpoint returns program budget changes that meet the following requirements:
  • The object is associated with a program budget with an ID value that matches the value of the {programBudgetId} path parameter.
Program Budget changes represent modifications or adjustments to program budgets.", "operationId":"/programBudgetChange/programBudget/{programBudgetId}_getBudgetChangesByProjectBudget_1", "parameters":[ { "name":"programBudgetId", "in":"path", "description":"The system-generated unique identifier of a program budget.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget change does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChange", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-programBudget-{programBudgetId}-get", "x-filename-id":"programbudgetchange-programbudget-programbudgetid-get" } }, "/programBudgetChange/syncBatch":{ "post":{ "tags":[ "Program Budget Change" ], "summary":"Batch Sync Program Budget Changes", "description":"Send a request to this endpoint to create or update one or more program budget changes.", "operationId":"/programBudgetChange/syncBatch_syncBatch_27", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any program budget change sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more budget change objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Program_Budget_Changes_Using_CBS_and_Cost_Category":{ "summary":"Batch Create or Update Program Budget Changes Using CBS and Cost Category", "description":"Payload to create or update one or more program budget changes using the program ID, program budget change code, and program budget change transactions.", "value":[ { "programBudgetChangeCode":"External Labor Change", "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":200 }, "programBudgetItemName":"External Labor", "desiredCode":"External Labor", "budgetCbsTemplateCodeId":14101, "budgetCostCategoryId":6001 } ], "programId":10001 } ], "valueSetFlag":true }, "Batch_Create_or_Update_Program_Budget_Changes_Using_Configured_Fields":{ "summary":"Batch Create or Update Program Budget Changes Using Configured Fields", "description":"Payload to create or update one or more program budget changes using the program ID, program budget change code, configured fields, and program budget change transactions of a program budget item.", "value":[ { "programBudgetChangeCode":"Construction Materials Change", "configuredFields":[ { "columnLabel":"ChangeValue", "columnDefinitionId":1427301, "textValue":"Changed the amount" } ], "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":10000 }, "programBudgetItemId":14001 } ], "programId":10001 } ], "valueSetFlag":true }, "Batch_Create_or_Update_Program_Budget_Changes_to_Assign_a_Configured_Field":{ "summary":"Batch Create or Update Program Budget Changes to Assign a Configured Field", "description":"Payload to create or update one or more program budget changes using the program ID, program budget change code, program budget change ID, program budget change transactions of a program budget item, and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "programBudgetChangeCode":"Construction Materials Change", "configuredFields":[ { "columnLabel":"Notes", "textValue":"program Budget change Notes - Budg1" }, { "columnDefinationId":61045, "textValue":"N" } ], "programBudgetChangeTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":10000 }, "programBudgetItemId":14001 } ], "programId":10001 }, { "programBudgetChangeId":102103, "programBudgetChangeTransactions":[ { "programBudgetTransactionId":238406, "programBudgetTransactionCost":{ "amountCostCOR":25000 } } ], "configuredFields":[ { "columnLabel":"Notes", "textValue":"program Budget change Notes - Budg2" }, { "columnDefinationId":60045, "numberValue":2 } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Change service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetChange-syncBatch-post", "x-filename-id":"programbudgetchange-syncbatch-post" } }, "/programBudgetItem":{ "put":{ "tags":[ "Program Budget Item" ], "summary":"Update a Program Budget Item", "description":"Send a request to this endpoint to update a program budget item. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/programBudgetItem_update_31", "requestBody":{ "description":"A program budget item object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetItemInput", "$ref":"#/components/schemas/ApiEntityProgramBudgetItemInput", "exampleSetFlag":false }, "examples":{ "Update_a_Program_Budget_Item_Using_Program_Budget_Item_ID":{ "summary":"Update a Program Budget Item Using Program Budget Item ID", "description":"Payload to update the original cost of a program budget item using the program budget item ID.", "value":{ "programBudgetItemId":194503, "programBudgetItemCost":{ "originalCostCOR":150000 } }, "valueSetFlag":true }, "Update_a_Program_Budget_Item_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Program Budget Item to Assign a Boolean Configured Field", "description":"Payload to update the original cost of a program budget item using the program budget item ID and configured field column label and text value.", "value":{ "programBudgetItemId":194503, "programBudgetItemCost":{ "originalCostCOR":150000 }, "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Program_Budget_Item_by_Removing_a_Configured_Field":{ "summary":"Update a Program Budget Item by Removing a Configured Field", "description":"Payload to update the original cost of a program budget item using the program budget item ID and specifying the action and column label for the configured field to be removed.", "value":{ "programBudgetItemId":194503, "programBudgetItemCost":{ "originalCostCOR":150000 }, "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Item service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetItem-put", "x-filename-id":"programbudgetitem-put" }, "post":{ "tags":[ "Program Budget Item" ], "summary":"Create a Program Budget Item", "description":"Send a request to this endpoint to create a program budget item. An application object will be created using the JSON data provided in the request body.", "operationId":"/programBudgetItem_create_33", "requestBody":{ "description":"A program budget item object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetItemInput", "$ref":"#/components/schemas/ApiEntityProgramBudgetItemInput", "exampleSetFlag":false }, "examples":{ "Create_a_Program_Budget_Item_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Program Budget Item that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a program budget item using the budget item name, budget item code, original cost, CBS template code ID, program ID, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "programBudgetItemName":"Construction Materials", "programBudgetItemCode":"1", "programBudgetItemCost":{ "originalCostCOR":100000 }, "cbsTemplateCodeId":410303, "programId":754504, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Program_Budget_Item":{ "summary":"Create a Program Budget Item", "description":"Payload to create a program budget item using the budget item name, budget item code, original cost, CBS template code ID, and program ID.", "value":{ "programBudgetItemName":"Construction Materials", "programBudgetItemCode":"1", "programBudgetItemCost":{ "originalCostCOR":100000 }, "cbsTemplateCodeId":410303, "programId":754504 }, "valueSetFlag":true }, "Create_a_Program_Budget_Item_that_includes_Configured_Field_Text":{ "summary":"Create a Program Budget Item that includes Configured Field Text", "description":"Payload to create a program budget item using the budget item name, budget item code, original cost, CBS template code ID, program ID, and values for the configured field which include column name and text value.", "value":{ "programBudgetItemName":"Construction Materials", "programBudgetItemCode":"1", "programBudgetItemCost":{ "originalCostCOR":100000 }, "cbsTemplateCodeId":410303, "programId":754504, "configuredFields":[ { "columnName":"Program Notes", "textValue":"Program is delayed due to some labor problems" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Item service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetItem", "$ref":"#/components/schemas/ApiEntityProgramBudgetItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetItem-post", "x-filename-id":"programbudgetitem-post" } }, "/programBudgetItem/batch":{ "put":{ "tags":[ "Program Budget Item" ], "summary":"Batch Update Program Budget Items", "description":"Send a request to this endpoint to update one or more program budget items. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/programBudgetItem/batch_updateBatch_27", "requestBody":{ "description":"One or more program budget item objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Program_Budget_Items_to_Assign_Configured_Field":{ "summary":"Batch Update Program Budget Items to Assign Configured Field", "description":"Payload to update the original cost of one or more program budget items using the program budget item IDs and configured field column name, column label, column definition ID, and text value.", "value":[ { "programBudgetItemId":194503, "programBudgetItemCost":{ "originalCostCOR":150000 }, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "programBudgetItemId":194502, "programBudgetItemCost":{ "originalCostCOR":250000 }, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "textValue":"N" } ] } ], "valueSetFlag":true }, "Batch_Update_Program_Budget_Items_Using_Program_Budget_Item_IDs":{ "summary":"Batch Update Program Budget Items Using Program Budget Item IDs", "description":"Payload to update the original cost of one or more program budget items using the program budget item IDs.", "value":[ { "programBudgetItemId":194503, "programBudgetItemCost":{ "originalCostCOR":150000 } }, { "programBudgetItemId":194502, "programBudgetItemCost":{ "originalCostCOR":250000 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Item service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"programBudgetItem-batch-put", "x-filename-id":"programbudgetitem-batch-put" }, "post":{ "tags":[ "Program Budget Item" ], "summary":"Batch Create Program Budget Items", "description":"Send a request to this endpoint to create one or more program budget items. An application object will be created for each JSON object provided in the request body.", "operationId":"/programBudgetItem/batch_createBatch_29", "requestBody":{ "description":"One or more program budget item objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Program_Budget_Items":{ "summary":"Batch Create Program Budget Items", "description":"Payload to create one or more program budget items using the budget item names, budget item codes, original costs, CBS template code IDs, and program IDs.", "value":[ { "programBudgetItemName":"Construction Materials", "programBudgetItemCode":"1", "programBudgetItemCost":{ "originalCostCOR":100000 }, "cbsTemplateCodeId":410303, "programId":754504 }, { "programBudgetItemName":"Internal Labor", "programBudgetItemCode":"2", "programBudgetItemCost":{ "originalCostCOR":200000 }, "cbsTemplateCodeId":410303, "programId":754504 } ], "valueSetFlag":true }, "Batch_Create_Program_Budget_Items_that_include_Configured_Field_Text":{ "summary":"Batch Create Program Budget Items that include Configured Field Text", "description":"Payload to create one or more program budget items using the budget item names, budget item codes, original costs, CBS template code IDs, program IDs, and and values for the configured field which include column name, column definition ID, text value.", "value":[ { "programBudgetItemName":"Construction Materials", "programBudgetItemCode":"1", "programBudgetItemCost":{ "originalCostCOR":100000 }, "cbsTemplateCodeId":410303, "programId":754504, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "programBudgetItemName":"Internal Labor", "programBudgetItemCode":"2", "programBudgetItemCost":{ "originalCostCOR":200000 }, "cbsTemplateCodeId":410303, "programId":754504, "configuredFields":[ { "columnName":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Item service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetItem-batch-post", "x-filename-id":"programbudgetitem-batch-post" }, "delete":{ "tags":[ "Program Budget Item" ], "summary":"Batch Delete Program Budget Items", "description":"Send a request to this endpoint to delete one or more program budget items. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/programBudgetItem/batch_deleteBatch_29", "requestBody":{ "description":"One or more system-generated identifiers of program budget items.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Item service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetItem-batch-delete", "x-filename-id":"programbudgetitem-batch-delete" } }, "/programBudgetItem/{programBudgetItemId}":{ "delete":{ "tags":[ "Program Budget Item" ], "summary":"Delete a Program Budget Item", "description":"Send a request to this endpoint to delete a program budget item. The application object with an ID value that matches the value of the {programBudgetItemId} path parameter will be deleted.", "operationId":"/programBudgetItem/{programBudgetItemId}_delete_33", "parameters":[ { "name":"programBudgetItemId", "in":"path", "description":"The system-generated identifier of a program budget item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Program Budget Item service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetItem-{programBudgetItemId}-delete", "x-filename-id":"programbudgetitem-programbudgetitemid-delete" } }, "/programBudgetItem/byItemCode":{ "get":{ "tags":[ "Program Budget Item" ], "summary":"View a Program Budget Item by Code and Parent Codes", "description":"Send a request to this endpoint to view a program budget item with codes matching the code fields in query parameters.", "operationId":"/programBudgetItem/byItemCode_getBudgetItemByCode_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the budget item to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"The user-specified unique identifier of a program.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programBudgetItemCode", "in":"query", "description":"The item code of a program budget item.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetItem", "$ref":"#/components/schemas/ApiEntityProgramBudgetItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetItem-byItemCode-get", "x-filename-id":"programbudgetitem-byitemcode-get" } }, "/programBudgetItem/program/{programId}":{ "get":{ "tags":[ "Program Budget Item" ], "summary":"View Program Budget Items by Program", "description":"This endpoint returns program budget items that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
Program budget items represent costs associated with labor or other program expenses.", "operationId":"/programBudgetItem/program/{programId}_getBudgetItemsByProject_1", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget item does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetItem-program-{programId}-get", "x-filename-id":"programbudgetitem-program-programid-get" } }, "/programBudgetItem/programBudget/{programBudgetId}":{ "get":{ "tags":[ "Program Budget Item" ], "summary":"View Program Budget Items by Program Budget", "description":"This endpoint returns program budget items that meet the following requirements:
  • The object is associated with a program budget with an ID value that matches the value of the {programBudgetId} path parameter.
Program budget items represent costs associated with labor or other program expenses.", "operationId":"/programBudgetItem/programBudget/{programBudgetId}_getBudgetItemsByProjectBudget_1", "parameters":[ { "name":"programBudgetId", "in":"path", "description":"The system-generated unique identifier of a program budget.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget item does not exist, or you do not have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetItem-programBudget-{programBudgetId}-get", "x-filename-id":"programbudgetitem-programbudget-programbudgetid-get" } }, "/programBudgetItem/syncBatch":{ "post":{ "tags":[ "Program Budget Item" ], "summary":"Batch Sync Program Budget Items", "description":"Send a request to this endpoint to create or update one or more program budget items.", "operationId":"/programBudgetItem/syncBatch_syncBatch_28", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any program budget item sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more program budget item objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Program_Budget_Item_Using_Cost_Category":{ "summary":"Create or Update a Program Budget Item Using Cost Category", "description":"Payload to create or update a program budget item using the budget item name, budget item code, labor rate, CBS template code ID, program ID, quantity, production rate, and cost category ID.", "value":[ { "programBudgetItemName":"Construction Materials", "programBudgetItemCode":"1", "programBudgetItemCost":{ "laborRateCOR":20 }, "cbsTemplateCodeId":6002, "quantity":20, "productionRate":10, "costCategoryId":10001, "programId":6001 } ], "valueSetFlag":true }, "Create_or_Update_a_Program_Budget_Item_to_Assign_a_Configured_Field":{ "summary":"Create or Update a Program Budget Item to Assign a Configured Field", "description":"Payload to create or update a program budget item using the budget item name, budget item code, original cost, CBS template code ID, program ID, program budget Item ID, and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "programBudgetItemName":"Construction Materials", "programBudgetItemCode":"1", "programBudgetItemCost":{ "originalCostCOR":100000 }, "cbsTemplateCodeId":6002, "programId":6001, "configuredFields":[ { "columnLabel":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":61045, "textValue":"N" } ] }, { "programBudgetItemId":194502, "configuredFields":[ { "columnLabel":"Notes", "textValue":"project Budget notes" }, { "columnDefinationId":60045, "numberValue":2 } ] } ], "valueSetFlag":true }, "Create_or_Update_a_Program_Budget_Item":{ "summary":"Create or Update a Program Budget Item", "description":"Payload to create or update a program budget item using the budget item name, budget item code, original cost, CBS template code ID, and program ID.", "value":[ { "programBudgetItemName":"Construction Materials", "programBudgetItemCode":"1", "programBudgetItemCost":{ "originalCostCOR":100000 }, "cbsTemplateCodeId":6002, "programId":6001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetItem-syncBatch-post", "x-filename-id":"programbudgetitem-syncbatch-post" } }, "/programBudgetTransfer/{programBudgetTransferId}/changeProgramBudgetTransferStatus":{ "put":{ "tags":[ "Program Budget Transfer" ], "summary":"Change a Program Budget Transfer Status", "description":"Send a request to this end point to modify the status of a program budget transfer.", "operationId":"/programBudgetTransfer/{programBudgetTransferId}/changeProgramBudgetTransferStatus_changeBudgetTransferStatus_1", "parameters":[ { "name":"programBudgetTransferId", "in":"path", "description":"The system-generated identifier of a budget transfer.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"A new status for the budget transfer.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStatusTransition", "$ref":"#/components/schemas/ApiEntityStatusTransition", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "responses":{ "404":{ "description":"The requested program budget transfer does not exist, or you do not have access to it." }, "400":{ "description":"Invalid input for the Program Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetTransfer-{programBudgetTransferId}-changeProgramBudgetTransferStatus-put", "x-filename-id":"programbudgettransfer-programbudgettransferid-changeprogrambudgettransferstatus-put" } }, "/programBudgetTransfer":{ "put":{ "tags":[ "Program Budget Transfer" ], "summary":"Update a Program Budget Transfer", "description":"Send a request to this endpoint to update a program budget transfer. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/programBudgetTransfer_update_32", "requestBody":{ "description":"A budget transfer object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetTransferInput", "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferInput", "exampleSetFlag":false }, "examples":{ "Update_a_Program_Budget_Transfer_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Program Budget Transfer to Assign a Boolean Configured Field", "description":"Payload to update the cost amount of a program budget transfer using the budget transfer ID, budget transaction cost ID, and configured field column label and text value.", "value":{ "programBudgetTransferId":72216, "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238427 }, { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238426 } ], "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ], "programId":754504 }, "valueSetFlag":true }, "Update_a_Program_Budget_Transfer_by_Removing_a_Configured_Field":{ "summary":"Update a Program Budget Transfer by Removing a Configured Field", "description":"Payload to update the cost amount of a program budget transfer using the budget transfer ID, budget transaction cost ID, and specifying the action and column label for the configured field to be removed.", "value":{ "programBudgetTransferId":72216, "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238427 }, { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238426 } ], "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ], "programId":754504 }, "valueSetFlag":true }, "Update_a_Program_Budget_Transfer_Using_Program_Budget_Transfer_ID":{ "summary":"Update a Program Budget Transfer Using Program Budget Transfer ID", "description":"Payload to update the cost amount of a program budget transfer using the budget transfer ID and budget transaction cost ID.", "value":{ "programBudgetTransferId":72216, "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238427 }, { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238426 } ], "programId":754504 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetTransfer-put", "x-filename-id":"programbudgettransfer-put" }, "post":{ "tags":[ "Program Budget Transfer" ], "summary":"Create a Program Budget Transfer", "description":"Send a request to this endpoint to create a program budget transfer. An application object will be created using the JSON data provided in the request body.", "operationId":"/programBudgetTransfer_create_34", "requestBody":{ "description":"A budget transfer object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetTransferInput", "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferInput", "exampleSetFlag":false }, "examples":{ "Create_a_Program_Budget_Transfer_from_Program_Budget_to_Program_Budget":{ "summary":"Create a Program Budget Transfer from Program Budget to Program Budget", "description":"Payload to create a program budget transfer from program budget to program budget using the budget transfer code, amount cost, budget item ID, transfer from budget item ID, transfer to budget item ID, budget transfer type, and program ID.", "value":{ "programBudgetTransferCode":"Materials to Labor", "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM" }, { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194502, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"TO", "transferToProgramBudgetItemId":194502 } ], "programId":754504 }, "valueSetFlag":true }, "Create_a_Program_Budget_Transfer_from_Project_Budget_to_Project_Budget":{ "summary":"Create a Program Budget Transfer from Project Budget to Project Budget", "description":"Payload to create a program budget transfer from project budget to project budget using the budget transfer code, amount cost, budget item ID, transfer to ID, transfer to ID, budget transfer type, and program ID.", "value":{ "programBudgetTransferCode":"Materials to External Labor", "programId":754504, "projectBudgetTransferTransactions":[ { "transferFromId":442201, "budgetTransactionCost":{ "amountCostProject":25000 }, "budgetItemId":442201, "budgetTransferType":"FROM" }, { "transferFromId":442201, "budgetItemId":442202, "budgetTransactionCost":{ "amountCostProject":25000 }, "budgetTransferType":"TO" } ] }, "valueSetFlag":true }, "Create_a_Program_Budget_Transfer_that_includes_Configured_Field_Text":{ "summary":"Create a Program Budget Transfer that includes Configured Field Text", "description":"Payload to create a program budget transfer from program budget to program budget using the budget transfer code, amount cost, budget item ID, transfer from budget item ID, transfer to budget item ID, budget transfer type, program ID, and values for the configured field which include column name and text value.", "value":{ "programBudgetTransferCode":"Materials to Labor", "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM", "configuredFields":[ { "columnName":"Notes-trans", "textValue":"program Budget transaction Notes" } ] }, { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194502, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"TO", "transferToProgramBudgetItemId":194502, "configuredFields":[ { "columnName":"Notes-trans", "textValue":"program Budget transaction Notes" } ] } ], "configuredFields":[ { "columnName":"Notes", "textValue":"program Budget transaction Notes" } ], "programId":754504 }, "valueSetFlag":true }, "Create_a_Program_Budget_Transfer_from_Program_Budget_to_Project_Budget":{ "summary":"Create a Program Budget Transfer from Program Budget to Project Budget", "description":"Payload to create a program budget transfer from program budget to project budget using the budget transfer code, amount cost, budget item ID, transfer from budget item ID, transfer to ID, cross entity transfer from ID budget transfer type, and program ID.", "value":{ "programBudgetTransferCode":"Materials to Internal Labor", "programId":754504, "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":50000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM" } ], "projectBudgetTransferTransactions":[ { "budgetItemId":442201, "budgetTransactionCost":{ "amountCostProject":50000 }, "budgetTransferType":"TO", "transferToId":442201, "crossEntityTransferFromId":194503 } ] }, "valueSetFlag":true }, "Create_a_Program_Budget_Transfer_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Program Budget Transfer that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a program budget transfer from program budget to program budget using the budget transfer code, amount cost, budget item ID, transfer from budget item ID, transfer to budget item ID, budget transfer type, and program ID.", "value":{ "programBudgetTransferCode":"Materials to Labor", "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM" }, { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194502, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"TO", "transferToProgramBudgetItemId":194502 } ], "configuredFields":[ { "columnName":"Notes", "textValue":"project transfer notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ], "programId":754504 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetTransfer", "$ref":"#/components/schemas/ApiEntityProgramBudgetTransfer", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-post", "x-filename-id":"programbudgettransfer-post" } }, "/programBudgetTransfer/batch":{ "put":{ "tags":[ "Program Budget Transfer" ], "summary":"Batch Update Program Budget Transfers", "description":"Send a request to this endpoint to update one or more program budget transfers. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/programBudgetTransfer/batch_updateBatch_28", "requestBody":{ "description":"One or more budget transfer objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Program_Budget_Transfers_Using_Program_Budget_Transfer_IDs":{ "summary":"Batch Update Program Budget Transfers Using Program Budget Transfer IDs", "description":"Payload to update the cost amount of one or more program budget transfers using the budget transfer IDs and budget transaction cost IDs.", "value":[ { "programBudgetTransferId":72216, "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238427 }, { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238426 } ], "programId":754504 }, { "programBudgetTransferId":72218, "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":7000 }, "programBudgetTransactionId":238431 }, { "programBudgetTransactionCost":{ "amountCostCOR":7000 }, "programBudgetTransactionId":238430 } ], "programId":754504 } ], "valueSetFlag":true }, "Batch_Update_Program_Budget_Transfers_to_Assign_Configured_Fields":{ "summary":"Batch Update Program Budget Transfers to Assign Configured Field", "description":"Payload to update the cost amount of one or more program budget transfers using the budget transfer IDs, budget transaction cost IDs, and configured field column name, column label, column definition ID, and text value.", "value":[ { "programBudgetTransferId":72216, "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238427 }, { "programBudgetTransactionCost":{ "amountCostCOR":6000 }, "programBudgetTransactionId":238426 } ], "configuredFields":[ { "columnName":"Notes", "textValue":"Program Budget transfer Notes - Budg1" }, { "columnDefinationId":60045, "textValue":"N" } ], "programId":754504 }, { "programBudgetTransferId":72218, "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":7000 }, "programBudgetTransactionId":238431 }, { "programBudgetTransactionCost":{ "amountCostCOR":7000 }, "programBudgetTransactionId":238430 } ], "configuredFields":[ { "columnName":"Notes", "textValue":"program Budget transfer Notes - Budg2" }, { "columnDefinationId":60045, "textValue":"N" } ], "programId":754504 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"programBudgetTransfer-batch-put", "x-filename-id":"programbudgettransfer-batch-put" }, "post":{ "tags":[ "Program Budget Transfer" ], "summary":"Batch Create Program Budget Transfers", "description":"Send a request to this endpoint to create one or more program budget transfers. An application object will be created for each JSON object provided in the request body.", "operationId":"/programBudgetTransfer/batch_createBatch_30", "requestBody":{ "description":"One or more budget transfer objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Program_Budget_Transfers_that_include_Configured_Field_Text":{ "summary":"Batch Create Program Budget Transfers that include Configured Field Text", "description":"Payload to create one or more program budget transfers using the budget transfer codes, cost amounts, budget item IDs, transfer from budget item IDs, transfer to budget item IDs, budget transfer types, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "programBudgetTransferCode":"Materials to Labor", "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM" }, { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194502, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"TO", "transferToProgramBudgetItemId":194502 } ], "configuredFields":[ { "columnName":"Notes", "textValue":"program Budget transfer Notes - Budg1" }, { "columnDefinationId":60045, "textValue":"N" } ], "programId":754504 }, { "programBudgetTransferCode":"Materials to Design", "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM" }, { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194502, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"TO", "transferToProgramBudgetItemId":194502 } ], "configuredFields":[ { "columnName":"Notes", "textValue":"program Budget transfer Notes - Budg2" }, { "columnDefinationId":60045, "textValue":"Y" } ], "programId":754504 } ], "valueSetFlag":true }, "Batch_Create_Program_Budget_Transfers":{ "summary":"Batch Create Program Budget Transfers", "description":"Payload to create one or more program budget transfers using the budget transfer codes, cost amounts, budget item IDs, transfer from budget item IDs, transfer to budget item IDs, and budget transfer types.", "value":[ { "programBudgetTransferCode":"Materials to Labor", "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM" }, { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194502, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"TO", "transferToProgramBudgetItemId":194502 } ], "programId":754504 }, { "programBudgetTransferCode":"Materials to Design", "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM" }, { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194502, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"TO", "transferToProgramBudgetItemId":194502 } ], "programId":754504 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-batch-post", "x-filename-id":"programbudgettransfer-batch-post" }, "delete":{ "tags":[ "Program Budget Transfer" ], "summary":"Batch Delete Program Budget Transfers", "description":"Send a request to this endpoint to delete one or more program budget transfers. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/programBudgetTransfer/batch_deleteBatch_30", "requestBody":{ "description":"One or more system-generated identifiers of budget transfers.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetTransfer-batch-delete", "x-filename-id":"programbudgettransfer-batch-delete" } }, "/programBudgetTransfer/{programBudgetTransferId}":{ "get":{ "tags":[ "Program Budget Transfer" ], "summary":"View a Program Budget Transfer", "description":"This endpoint returns program budget transfers that meet the following requirements:
  • The object is associated with a program budget transfer with an ID value that matches the value of the {programBudgetTransferId} path parameter.
Program Budget transfers represent adjustments to program budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/programBudgetTransfer/{programBudgetTransferId}_find_46", "parameters":[ { "name":"programBudgetTransferId", "in":"path", "description":"The system-generated identifier of a budget transfer.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget transfer does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetTransfer", "$ref":"#/components/schemas/ApiEntityProgramBudgetTransfer", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-{programBudgetTransferId}-get", "x-filename-id":"programbudgettransfer-programbudgettransferid-get" }, "delete":{ "tags":[ "Program Budget Transfer" ], "summary":"Delete a Program Budget Transfer", "description":"Send a request to this endpoint to delete a program budget transfer. The application object with an ID value that matches the value of the {budgetTransferId} path parameter will be deleted.", "operationId":"/programBudgetTransfer/{programBudgetTransferId}_delete_34", "parameters":[ { "name":"programBudgetTransferId", "in":"path", "description":"The system-generated identifier of a budget transfer.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Program Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programBudgetTransfer-{programBudgetTransferId}-delete", "x-filename-id":"programbudgettransfer-programbudgettransferid-delete" } }, "/programBudgetTransfer/{programBudgetTransferId}/statusTransitionHistory":{ "get":{ "tags":[ "Program Budget Transfer" ], "summary":"View Status Transition History Records by Program Budget Transfer", "description":"This endpoint returns status transition histories of program budget transfers that meet the following requirements:
  • The object is associated with a program budget transfer with an ID value that matches the value of the {programBudgetTransferId} path parameter.
Program Budget transfers represent adjustments to program budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/programBudgetTransfer/{programBudgetTransferId}/statusTransitionHistory_findTransitionHistoryByBudgetTransferId_1", "parameters":[ { "name":"programBudgetTransferId", "in":"path", "description":"The system-generated identifier of a budget transfer.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested status transition history record does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-{programBudgetTransferId}-statusTransitionHistory-get", "x-filename-id":"programbudgettransfer-programbudgettransferid-statustransitionhistory-get" } }, "/programBudgetTransfer/program/{programId}/statusTransitionHistory":{ "get":{ "tags":[ "Program Budget Transfer" ], "summary":"View Status Transition History Records by Program", "description":"This endpoint returns program budget transfer status transition histories that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
Program Budget transfers represent adjustments to program budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/programBudgetTransfer/program/{programId}/statusTransitionHistory_findTransitionHistoryByProjectId_3", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested status transition history record does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-program-{programId}-statusTransitionHistory-get", "x-filename-id":"programbudgettransfer-program-programid-statustransitionhistory-get" } }, "/programBudgetTransfer/byParent":{ "get":{ "tags":[ "Program Budget Transfer" ], "summary":"View all Program Budget Transfers by Parent", "description":"Send a request to this end point to view all program budget transfers under parent with codes matching the code fields in query parameters.", "operationId":"/programBudgetTransfer/byParent_getAllBudgetTransferByCode_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the budget transfers have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"The user-specified unique identifier of a program.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-byParent-get", "x-filename-id":"programbudgettransfer-byparent-get" } }, "/programBudgetTransfer/byItemCode":{ "get":{ "tags":[ "Program Budget Transfer" ], "summary":"View a Program Budget Transfer by Code and Parent Codes", "description":"Send a request to this end point to view a program budget transfer with codes matching the code fields in query parameters.", "operationId":"/programBudgetTransfer/byItemCode_getBudgetTransferByCode_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the budget transfer to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"Project code of the budget transfer to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programBudgetTransferCode", "in":"query", "description":"The user-specified identifier of a budget transfer.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramBudgetTransfer", "$ref":"#/components/schemas/ApiEntityProgramBudgetTransfer", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-byItemCode-get", "x-filename-id":"programbudgettransfer-byitemcode-get" } }, "/programBudgetTransfer/program/{programId}":{ "get":{ "tags":[ "Program Budget Transfer" ], "summary":"View Program Budget Transfers by Program", "description":"This endpoint returns program budget transfers that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
Program Budget transfers represent adjustments to program budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/programBudgetTransfer/program/{programId}_getBudgetTransfersByProject_1", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget transfer does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-program-{programId}-get", "x-filename-id":"programbudgettransfer-program-programid-get" } }, "/programBudgetTransfer/programBudget/{programBudgetId}":{ "get":{ "tags":[ "Program Budget Transfer" ], "summary":"View Program Budget Transfers by Program Budget", "description":"This endpoint returns program budget transfers that meet the following requirements:
  • The object is associated with a program budget with an ID value that matches the value of the {programBudgetId} path parameter.
Program Budget transfers represent adjustments to program budget line item costs, and capture costs that were moved from one line item to another.", "operationId":"/programBudgetTransfer/programBudget/{programBudgetId}_getBudgetTransfersByProjectBudget_1", "parameters":[ { "name":"programBudgetId", "in":"path", "description":"The system-generated unique identifier of a program budget.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program budget transfer does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransfer", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-programBudget-{programBudgetId}-get", "x-filename-id":"programbudgettransfer-programbudget-programbudgetid-get" } }, "/programBudgetTransfer/syncBatch":{ "post":{ "tags":[ "Program Budget Transfer" ], "summary":"Batch Sync Program Budget Transfers", "description":"Send a request to this endpoint to create or update one or more program budget transfers.", "operationId":"/programBudgetTransfer/syncBatch_syncBatch_29", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any program budget transfer sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more budget transfer objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Program_Budget_Transfers_Using_Configured_Fields":{ "summary":"Batch Create or Update Program Budget Transfers Using Configured Fields", "description":"Payload to create or update one or more program budget transfers using the program ID, program budget transfer code, configured fields, and program budget transfer transactions.", "value":[ { "programBudgetTransferCode":"Materials to Labor", "configuredFields":[ { "columnLabel":"TrnasferValue", "columnDefinitionId":1427301, "textValue":"Tranfer the amount" } ], "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM" }, { "programBudgetTransactionCost":{ "amountCostCOR":5000 }, "programBudgetItemId":194502, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"TO", "transferToProgramBudgetItemId":194502 } ], "programId":754504 } ], "valueSetFlag":true }, "Batch_Create_or_Update_Program_Budget_Transfer_from_Program_Budget_to_Project_Budget.":{ "summary":"Batch Create or Update Program Budget Transfer from Program Budget to Project Budget.", "description":"Payload to create or update one or more program budget transfers from program budget to project budget using the budget transfer code, amount cost, budget item ID, transfer-from budget item ID, transfer-to ID, cross-entity-transfer-from ID, budget transfer type, program code, and workspace code.", "value":[ { "programBudgetTransferCode":"Materials to Internal Labor", "programCode":"Juniper Program", "workspaceCode":"North America", "programBudgetTransferTransactions":[ { "programBudgetTransactionCost":{ "amountCostCOR":50000 }, "programBudgetItemId":194503, "transferFromProgramBudgetItemId":194503, "budgetTransferType":"FROM" } ], "projectBudgetTransferTransactions":[ { "budgetItemId":442201, "budgetTransactionCost":{ "amountCostProject":50000 }, "budgetTransferType":"TO", "transferToId":442201, "crossEntityTransferFromId":194503 } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Program Budget Transfer service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programBudgetTransfer-syncBatch-post", "x-filename-id":"programbudgettransfer-syncbatch-post" } }, "/programMeasureValue/{programMeasureValueId}":{ "get":{ "tags":[ "Program Measure Value" ], "summary":"View a Program Measure Value ", "description":"Send a request to this endpoint to view a program measure value for the specified programMeasureValueId. ", "operationId":"/programMeasureValue/{programMeasureValueId}_find_47", "parameters":[ { "name":"programMeasureValueId", "in":"path", "description":"The system-generated identifier of a program measure value;", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program measure value does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramMeasureValue", "$ref":"#/components/schemas/ApiEntityProgramMeasureValue", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programMeasureValue-{programMeasureValueId}-get", "x-filename-id":"programmeasurevalue-programmeasurevalueid-get" } }, "/programMeasureValue/program":{ "get":{ "tags":[ "Program Measure Value" ], "summary":"View all Program Measure Values by Program Code and Workspace Code ", "description":"Send a request to this endpoint to view program measure values for the specified programCode and workspaceCode.", "operationId":"/programMeasureValue/program_findByProgram", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace;
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"The user-specified identifier of a program;
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programMeasureValue-program-get", "x-filename-id":"programmeasurevalue-program-get" } }, "/programMeasureValue/measure":{ "get":{ "tags":[ "Program Measure Value" ], "summary":"View all Program Measure Values by Measure Name and Workspace Code ", "description":"Send a request to this endpoint to view program measure values for the specified measureName and workspaceCode.", "operationId":"/programMeasureValue/measure_findbyMeasure", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace;
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"measureName", "in":"query", "description":"The name of the measure.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programMeasureValue-measure-get", "x-filename-id":"programmeasurevalue-measure-get" } }, "/programMeasureValue/measure/{measureId}":{ "get":{ "tags":[ "Program Measure Value" ], "summary":"View all Program Measure Values by Measure ", "description":"Send a request to this endpoint to view program measure values for the specified measureId. ", "operationId":"/programMeasureValue/measure/{measureId}_getProgramMeasuresByMeasureId", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure;", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program measure value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programMeasureValue-measure-{measureId}-get", "x-filename-id":"programmeasurevalue-measure-measureid-get" } }, "/programMeasureValue/program/{programId}":{ "get":{ "tags":[ "Program Measure Value" ], "summary":"View all Program Measure Values by Program", "description":"Send a request to this endpoint to view program measure values for the specified programId.", "operationId":"/programMeasureValue/program/{programId}_getProgramMeasuresByProgramId", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated identifier of a program;", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program measure value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programMeasureValue-program-{programId}-get", "x-filename-id":"programmeasurevalue-program-programid-get" } }, "/programRisk":{ "put":{ "tags":[ "Program Risk" ], "summary":"Update a Program Risk", "description":"Send a request to this endpoint to update a program risk.", "operationId":"/programRisk_update_33", "requestBody":{ "description":"A program risk object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskInput", "$ref":"#/components/schemas/ApiEntityProgramRiskInput", "exampleSetFlag":false }, "examples":{ "Update_a_Program_Risk_Using_Program_Risk_ID":{ "summary":"Update a Program Risk Using Program Risk ID", "description":"Payload to update the owner and program risk status using the program risk ID.", "value":{ "programRiskId":76002, "ownerId":10001, "programRiskStatus":"IMPACTED" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programRisk-put", "x-filename-id":"programrisk-put" }, "post":{ "tags":[ "Program Risk" ], "summary":"Create a Program Risk", "description":"Send a request to this endpoint to create a program risk.", "operationId":"/programRisk_create_35", "requestBody":{ "description":"A program risk object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskInput", "$ref":"#/components/schemas/ApiEntityProgramRiskInput", "exampleSetFlag":false }, "examples":{ "Create_a_Program_Risk":{ "summary":"Create a Program Risk", "description":"Payload to create a program risk using the program ID, program risk code, name, description, cause, effect, type, status, and impacts.", "value":{ "programId":52001, "riskCode":"R02", "riskName":"Delay in Permit Approval", "description":"Permit Approval delayed due to COVID", "effect":"Delay in starting the project", "riskType":"THREAT", "programRiskStatus":"OPEN", "programRiskImpacts":[ { "riskScoreThresholdCode":"H", "riskScoreTypeName":"Small Projects Schedule Threshold" }, { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Cost Threshold" }, { "riskScoreThresholdCode":"H", "riskScoreTypeName":"Probability" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRisk", "$ref":"#/components/schemas/ApiEntityProgramRisk", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programRisk-post", "x-filename-id":"programrisk-post" } }, "/programRisk/batch":{ "put":{ "tags":[ "Program Risk" ], "summary":"Batch Update Program Risks", "description":"Send a request to this endpoint to update one or more program risks.", "operationId":"/programRisk/batch_updateBatch_29", "requestBody":{ "description":"A program risk object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Program_Risks_Using_Program_Risk_IDs":{ "summary":"Batch Update Program Risks Using Program Risk IDs", "description":"Payload to update the owners and program risk statuses of one or more program risks using the program risk IDs.", "value":[ { "programRiskId":76002, "ownerId":10001, "programRiskStatus":"IMPACTED" }, { "programRiskId":76003, "ownerId":10001, "programRiskStatus":"CANNOT_IMPACT" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"programRisk-batch-put", "x-filename-id":"programrisk-batch-put" }, "post":{ "tags":[ "Program Risk" ], "summary":"Batch Create Program Risks", "description":"Send a request to this endpoint to create one or more program risks.", "operationId":"/programRisk/batch_createBatch_31", "requestBody":{ "description":"A program risk object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Program_Risks":{ "summary":"Batch Create Program Risks", "description":"Payload to create one or more program risks using the program IDs, program risk codes, names, descriptions, effects, types, statuses, and impacts.", "value":[ { "programId":52001, "riskCode":"R04", "riskName":"Delay in Permit Approval", "description":"Permit Approval delayed due to COVID", "effect":"Delay in starting the project", "riskType":"THREAT", "programRiskStatus":"OPEN", "programRiskImpacts":[ { "riskScoreThresholdCode":"H", "riskScoreTypeName":"Small Projects Schedule Threshold" }, { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Cost Threshold" }, { "riskScoreThresholdCode":"H", "riskScoreTypeName":"Probability" } ] }, { "programId":52001, "riskCode":"R03", "riskName":"Allowance for working times", "description":"Paying extra money for overtime", "effect":"Work will be completed before the estimated time", "riskType":"OPPORTUNITY", "programRiskStatus":"PROPOSED", "programRiskImpacts":[ { "riskScoreThresholdCode":"L", "riskScoreTypeName":"Small Projects Schedule Threshold" }, { "riskScoreThresholdCode":"H", "riskScoreTypeName":"Small Projects Cost Threshold" }, { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Probability" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRisk-batch-post", "x-filename-id":"programrisk-batch-post" }, "delete":{ "tags":[ "Program Risk" ], "summary":"Batch Delete Program Risks", "description":"Send a request to this endpoint to delete one or more program risks.", "operationId":"/programRisk/batch_deleteBatch_31", "requestBody":{ "description":"IDs of the program risks to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programRisk-batch-delete", "x-filename-id":"programrisk-batch-delete" } }, "/programRisk/{programRiskId}":{ "get":{ "tags":[ "Program Risk" ], "summary":"View a Program Risk", "description":"This endpoint returns program risks that meet the following requirements:
  • The object has an ID that matches the value of the {programRiskId} path parameter.
", "operationId":"/programRisk/{programRiskId}_find_48", "parameters":[ { "name":"programRiskId", "in":"path", "description":"The system-generated identifier of a program risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRisk", "$ref":"#/components/schemas/ApiEntityProgramRisk", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programRisk-{programRiskId}-get", "x-filename-id":"programrisk-programriskid-get" }, "delete":{ "tags":[ "Program Risk" ], "summary":"Delete a Program Risk", "description":"Send a request to this endpoint to delete a program risk. The application object with an ID value that matches the value of the {programRiskId} path parameter will be deleted.", "operationId":"/programRisk/{programRiskId}_delete_35", "parameters":[ { "name":"programRiskId", "in":"path", "description":"The system-generated identifier of a program risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programRisk-{programRiskId}-delete", "x-filename-id":"programrisk-programriskid-delete" } }, "/programRisk/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Program Risk" ], "summary":"View all Program Risks by Assigned CodeValue", "description":"This endpoint returns program risks that meet the following requirements:
  • The object is assigned a code type that matches the value of the {codeTypeId} path parameter with a value that matches the value of the {codeValueCode} path parameter.
", "operationId":"/programRisk/codeType/{codeTypeId}/codeValue/{codeValueCode}_findByCodeValue_1", "parameters":[ { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRisk-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"programrisk-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/programRisk/name/{riskName}":{ "get":{ "tags":[ "Program Risk" ], "summary":"View all Program Risks by Name", "description":"Send a request to this endpoint to view a project risk with a name value matching the value of the {riskName} path parameter.", "operationId":"/programRisk/name/{riskName}_findByName_9", "parameters":[ { "name":"riskName", "in":"path", "description":"The name of the program risk.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRisk-name-{riskName}-get", "x-filename-id":"programrisk-name-riskname-get" } }, "/programRisk/program/{programId}/riskCode/{riskCode}":{ "get":{ "tags":[ "Program Risk" ], "summary":"View a Program Risk by Program and Risk Code", "description":"This endpoint returns program risks that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
  • The object has a risk with a code value that matches the value of the {riskCode} path parameter.
", "operationId":"/programRisk/program/{programId}/riskCode/{riskCode}_findByProgramIdAndRiskCode", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"riskCode", "in":"path", "description":"The user-specified identifier of a risk.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRisk", "$ref":"#/components/schemas/ApiEntityProgramRisk", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programRisk-program-{programId}-riskCode-{riskCode}-get", "x-filename-id":"programrisk-program-programid-riskcode-riskcode-get" } }, "/programRisk/programId/{programId}":{ "get":{ "tags":[ "Program Risk" ], "summary":"View all Program Risks by Program ", "description":"This endpoint returns program risks that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
", "operationId":"/programRisk/programId/{programId}_getProgramRisksByProgram", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRisk-programId-{programId}-get", "x-filename-id":"programrisk-programid-programid-get" } }, "/programRisk/workspace/{workspaceId}":{ "get":{ "tags":[ "Program Risk" ], "summary":"View all Program Risks in a Workspace", "description":"This endpoint returns program risks that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/programRisk/workspace/{workspaceId}_getProgramRisksByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRisk-workspace-{workspaceId}-get", "x-filename-id":"programrisk-workspace-workspaceid-get" } }, "/programRisk/syncBatch":{ "post":{ "tags":[ "Program Risk" ], "summary":"Batch Sync Program Risks", "description":"Send a request to this endpoint to create or update one or more program risks.", "operationId":"/programRisk/syncBatch_syncBatch_30", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any program risk sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"A program risk object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Program_Risks_Using_Codes":{ "summary":"Batch Create or Update Program Risks Using Codes", "description":"Payload to create one or more program risks using the program code, workspace code, program risk code, name, descriptions, effect, type, status, and impacts.", "value":[ { "workspaceCode":"North America", "programCode":"Enterprise Initiative", "riskCode":"R04", "riskName":"Delay in Permit Approval", "description":"Permit Approval delayed due to COVID", "effect":"Delay in starting the project", "riskType":"THREAT", "programRiskStatus":"OPEN", "programRiskImpacts":[ { "riskScoreThresholdCode":"H", "riskScoreTypeName":"Small Projects Schedule Threshold" }, { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Cost Threshold" }, { "riskScoreThresholdCode":"H", "riskScoreTypeName":"Probability" } ] } ], "valueSetFlag":true }, "Batch_Create_or_Update_Program_Risks_Using_Code_Values_and_Configured_Fields":{ "summary":"Batch Create or Update Program Risks Using Code Values and Configured Fields", "description":"Payload to create or update one or more program risks using the program ID, risk code, risk name, description, effect, risk type, program risk status, code values of program risk fields such as code type code and code value code,and configured fields such as column name and text value.", "value":[ { "programId":52001, "riskCode":"R02", "riskName":"Delay in Permit Approval", "description":"Permit Approval delayed due to COVID", "effect":"Delay in starting the project", "riskType":"THREAT", "programRiskStatus":"OPEN", "codeValuesProgramRisk":[ { "codeTypeCode":"RISK_PESTLE_CODE", "codeValueCode":"ENV" } ], "configuredFields":[ { "columnName":"RISK_LEVEL", "textValue":"HIGH" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRisk-syncBatch-post", "x-filename-id":"programrisk-syncbatch-post" } }, "/programRiskMitigation":{ "put":{ "tags":[ "Program Risk Mitigation" ], "summary":"Update a Program Risk Mitigation", "description":"Send a request to this endpoint to update a program risk mitigation.", "operationId":"/programRiskMitigation_update_34", "requestBody":{ "description":"A program risk mitigation object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskMitigationInput", "$ref":"#/components/schemas/ApiEntityProgramRiskMitigationInput", "exampleSetFlag":false }, "examples":{ "Update_a_Program_Risk_Mitigation_Using_Program_Risk_Mitigation_ID":{ "summary":"Update a Program Risk Mitigation Using Program Risk Mitigation ID", "description":"Payload to update the end date of a program risk mitigation using the program risk mitigation ID.", "value":{ "programRiskMitigationId":78003, "finishDate":"2023-03-20T00:00:00" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programRiskMitigation-put", "x-filename-id":"programriskmitigation-put" }, "post":{ "tags":[ "Program Risk Mitigation" ], "summary":"Create a Program Risk Mitigation", "description":"Send a request to this endpoint to create a program risk mitigation.", "operationId":"/programRiskMitigation_create_36", "requestBody":{ "description":"A program risk mitigation object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskMitigationInput", "$ref":"#/components/schemas/ApiEntityProgramRiskMitigationInput", "exampleSetFlag":false }, "examples":{ "Create_a_Program_Risk_Mitigation":{ "summary":"Create a Program Risk Mitigation", "description":"Payload to create a program risk mitigation using the program risk ID, program risk mitigation code, name, mitigation status, and start and end dates.", "value":{ "programRiskMitigationName":"Continuous liaison with the engineer and Authorities shall be kept", "programRiskId":16043, "programRiskMitigationCode":"PR01", "mitigationStatus":"NOT_STARTED", "startDate":"2023-03-06T00:00:00", "finishDate":"2023-03-25T00:00:00" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskMitigation", "$ref":"#/components/schemas/ApiEntityProgramRiskMitigation", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskMitigation-post", "x-filename-id":"programriskmitigation-post" } }, "/programRiskMitigation/batch":{ "put":{ "tags":[ "Program Risk Mitigation" ], "summary":"Batch Update Program Risk Mitigations", "description":"Send a request to this endpoint to update one or more program risk mitigations.", "operationId":"/programRiskMitigation/batch_updateBatch_30", "requestBody":{ "description":"A program risk mitigation object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskMitigationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Program_Risk_Mitigations_Using_Program_Risk_Mitigation_IDs":{ "summary":"Batch Update Program Risk Mitigations Using Program Risk Mitigation IDs", "description":"Payload to update the end dates of one or more program risk mitigations using the program risk mitigation IDs.", "value":[ { "programRiskMitigationId":78003, "finishDate":"2023-03-20T00:00:00" }, { "programRiskMitigationId":78004, "finishDate":"2023-03-18T00:00:00" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"programRiskMitigation-batch-put", "x-filename-id":"programriskmitigation-batch-put" }, "post":{ "tags":[ "Program Risk Mitigation" ], "summary":"Batch Create Program Risk Mitigations", "description":"Send a request to this endpoint to create one or more program risk mitigations.", "operationId":"/programRiskMitigation/batch_createBatch_32", "requestBody":{ "description":"One or more program risk mitigation objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskMitigationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Program_Risk_Mitigations":{ "summary":"Batch Create Program Risk Mitigations", "description":"Payload to create one or more program risk mitigations using the program risk IDs, program risk mitigation codes, names, statuses, and start and end dates.", "value":[ { "programRiskMitigationName":"Continuous liaison with the engineer and Authorities shall be kept", "programRiskId":16043, "programRiskMitigationCode":"PR01", "mitigationStatus":"NOT_STARTED", "startDate":"2023-03-06T00:00:00", "finishDate":"2023-03-25T00:00:00" }, { "programRiskMitigationName":"local rules and legal procedures shall be well examined", "programRiskId":16043, "programRiskMitigationCode":"PR02", "mitigationStatus":"NOT_STARTED", "startDate":"2023-03-06T00:00:00", "finishDate":"2023-03-25T00:00:00" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskMitigation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskMitigation-batch-post", "x-filename-id":"programriskmitigation-batch-post" }, "delete":{ "tags":[ "Program Risk Mitigation" ], "summary":"Batch Delete Program Risk Mitigations", "description":"Send a request to this endpoint to delete one or more program risk mitigations.", "operationId":"/programRiskMitigation/batch_deleteBatch_32", "requestBody":{ "description":"The system-generated identifier of a program risk mitigation.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programRiskMitigation-batch-delete", "x-filename-id":"programriskmitigation-batch-delete" } }, "/programRiskMitigation/{programRiskMitigationId}":{ "get":{ "tags":[ "Program Risk Mitigation" ], "summary":"View a Program Risk Mitigation", "description":"This endpoint returns program risk mitigations that meet the following requirements:
  • The object has an ID that matches the value of the {programRiskMitigationId} path parameter.
", "operationId":"/programRiskMitigation/{programRiskMitigationId}_find_49", "parameters":[ { "name":"programRiskMitigationId", "in":"path", "description":"The system-generated identifier of a program risk mitigation.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program risk mitigation does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskMitigation", "$ref":"#/components/schemas/ApiEntityProgramRiskMitigation", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskMitigation-{programRiskMitigationId}-get", "x-filename-id":"programriskmitigation-programriskmitigationid-get" }, "delete":{ "tags":[ "Program Risk Mitigation" ], "summary":"Delete a Program Risk Mitigation", "description":"Send a request to this endpoint to delete a program risk mitigation. The application object with an ID value that matches the value of the {programRiskMitigationId} path parameter will be deleted.", "operationId":"/programRiskMitigation/{programRiskMitigationId}_delete_36", "parameters":[ { "name":"programRiskMitigationId", "in":"path", "description":"The system-generated identifier of a program risk mitigation.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programRiskMitigation-{programRiskMitigationId}-delete", "x-filename-id":"programriskmitigation-programriskmitigationid-delete" } }, "/programRiskMitigation/code/{programRiskMitigationCode}":{ "get":{ "tags":[ "Program Risk Mitigation" ], "summary":"View all Program Risk Mitigations by Code", "description":"This endpoint returns program risk mitigations that meet the following requirements:
  • The object has a code that matches the value of the {programRiskMitigationCode} path parameter.
", "operationId":"/programRiskMitigation/code/{programRiskMitigationCode}_findByCode_9", "parameters":[ { "name":"programRiskMitigationCode", "in":"path", "description":"The user-specified identifier of a program risk mitigation.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested program risk mitigation does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskMitigation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskMitigation-code-{programRiskMitigationCode}-get", "x-filename-id":"programriskmitigation-code-programriskmitigationcode-get" } }, "/programRiskMitigation/programRisk/{programRiskId}":{ "get":{ "tags":[ "Program Risk Mitigation" ], "summary":"View all Program Risk Mitigations by Program Risk ID", "description":"This endpoint returns program risk mitigations that meet the following requirements:
  • The object is associated with a program risk with an ID value that matches the value of the {programRiskId} path parameter.
", "operationId":"/programRiskMitigation/programRisk/{programRiskId}_findByCodeAndProgramRisk", "parameters":[ { "name":"programRiskId", "in":"path", "description":"The system-generated identifier of a program risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskMitigation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskMitigation-programRisk-{programRiskId}-get", "x-filename-id":"programriskmitigation-programrisk-programriskid-get" } }, "/programRiskMitigation/program/{programId}":{ "get":{ "tags":[ "Program Risk Mitigation" ], "summary":"View all Program Risk Mitigations by Program ID", "description":"This endpoint returns program risk mitigations that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
", "operationId":"/programRiskMitigation/program/{programId}_findByProgramId_1", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskMitigation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskMitigation-program-{programId}-get", "x-filename-id":"programriskmitigation-program-programid-get" } }, "/programRiskMitigation/syncBatch":{ "post":{ "tags":[ "Program Risk Mitigation" ], "summary":"Batch Sync Program Risk Mitigations", "description":"Send a request to this endpoint to create or update one or more program risk mitigations.", "operationId":"/programRiskMitigation/syncBatch_syncBatch_31", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any program risk mitigation sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more program risk mitigation objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskMitigationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Program_Risk_Mitigations":{ "summary":"Batch Create or Update Program Risk Mitigations", "description":"Payload to create or update one or more program risk mitigations using the program code, workspace code, risk code, mitigation status, owner ID, program risk mitigation name, program risk mitigation code, and program risk mitigation financial fields such as remaining total cost, and start and end dates.", "value":[ { "programRiskMitigationCode":"M1", "programRiskMitigationName":"Apply drainage and stone to areas impacted..", "mitigationStatus":"PROPOSED", "startDate":"2023-03-06T00:00:00", "finishDate":"2023-03-25T00:00:00", "programCode":"Enterprise Initiative", "workspaceCode":"North America", "riskCode":"R1", "ownerId":10001, "programRiskMitigationFinancial":{ "remainingTotalCost":200 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskMitigation-syncBatch-post", "x-filename-id":"programriskmitigation-syncbatch-post" } }, "/programRiskWeatherPeriod":{ "put":{ "tags":[ "Program Risk Weather Period" ], "summary":"Update a Program Risk Weather Period", "description":"Send a request to this endpoint to update a program risk weather period.", "operationId":"/programRiskWeatherPeriod_update_35", "requestBody":{ "description":"A program risk weather period object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskWeatherPeriodInput", "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriodInput", "exampleSetFlag":false }, "examples":{ "Update_a_Program_Risk_Weather_Period_Using_Program_Risk_Weather_Period_ID":{ "summary":"Update a Program Risk Weather Period Using Program Risk Weather Period ID", "description":"Payload to update the maximum, minimum and the most probable number of nonworking days using the program risk weather period ID.", "value":{ "programRiskWeatherPeriodId":54101, "maxNonWorkingDays":28, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":10 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programRiskWeatherPeriod-put", "x-filename-id":"programriskweatherperiod-put" }, "post":{ "tags":[ "Program Risk Weather Period" ], "summary":"Create a Program Risk Weather Period", "description":"Send a request to this endpoint to create a program risk weather period.", "operationId":"/programRiskWeatherPeriod_create_37", "requestBody":{ "description":"A program risk weather period object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskWeatherPeriodInput", "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriodInput", "exampleSetFlag":false }, "examples":{ "Create_a_Program_Risk_Weather_Period":{ "summary":"Create a Program Risk Weather Period", "description":"Payload to create a program risk weather period using the program risk ID, period name, period start and finish dates, nonworking time definition type, maximum, and minimum nonworking days, and the most probable number of nonworking days, and shape.", "value":{ "programRiskId":62103, "periodName":"Heat Waves", "periodStart":"2022-04-03T00:00:00", "periodFinish":"2022-06-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":18, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":15, "shape":"TRIANGLE" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskWeatherPeriod", "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriod", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskWeatherPeriod-post", "x-filename-id":"programriskweatherperiod-post" } }, "/programRiskWeatherPeriod/batch":{ "put":{ "tags":[ "Program Risk Weather Period" ], "summary":"Batch Update Program Risk Weather Periods", "description":"Send a request to this endpoint to update one or more program risk weather periods.", "operationId":"/programRiskWeatherPeriod/batch_updateBatch_31", "requestBody":{ "description":"A program risk weather period object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriodInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Program_Risk_Weather_Periods_Using_Program_Risk_Weather_Period_IDs":{ "summary":"Batch Update Program Risk Weather Periods Using Program Risk Weather Period IDs", "description":"Payload to update the maximum, minimum and the most probable number of non-working days for one or more program risk weather periods using the risk weather period IDs.", "value":[ { "programRiskWeatherPeriodId":54101, "maxNonWorkingDays":28, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":10 }, { "programRiskWeatherPeriodId":54102, "maxNonWorkingDays":20, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":10 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"programRiskWeatherPeriod-batch-put", "x-filename-id":"programriskweatherperiod-batch-put" }, "post":{ "tags":[ "Program Risk Weather Period" ], "summary":"Batch Create Program Risk Weather Periods", "description":"Send a request to this endpoint to create one or more program risk weather periods.", "operationId":"/programRiskWeatherPeriod/batch_createBatch_33", "requestBody":{ "description":"One or more program risk weather period objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriodInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Program_Risk_Weather_Periods":{ "summary":"Batch Create Program Risk Weather Periods", "description":"Payload to create a program risk weather periods using the program risk IDs, period names, period start and finish dates, nonworking time definition types, maximum, and minimum nonworking days, and the most probable number of nonworking days, and shapes.", "value":[ { "programRiskId":62103, "periodName":"Heat Waves", "periodStart":"2022-04-03T00:00:00", "periodFinish":"2022-06-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":18, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":15, "shape":"TRIANGLE" }, { "programRiskId":62103, "periodName":"Extreme Cold", "periodStart":"2023-01-13T00:00:00", "periodFinish":"2023-02-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":20, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":10, "shape":"TRIANGLE" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskWeatherPeriod-batch-post", "x-filename-id":"programriskweatherperiod-batch-post" }, "delete":{ "tags":[ "Program Risk Weather Period" ], "summary":"Batch Delete Program Risk Weather Periods", "description":"Send a request to this endpoint to delete one or more program risk weather periods.", "operationId":"/programRiskWeatherPeriod/batch_deleteBatch_33", "requestBody":{ "description":"The system-generated identifier of a program risk weather period.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programRiskWeatherPeriod-batch-delete", "x-filename-id":"programriskweatherperiod-batch-delete" } }, "/programRiskWeatherPeriod/{programRiskWeatherPeriodId}":{ "get":{ "tags":[ "Program Risk Weather Period" ], "summary":"View a Program Risk Weather Period", "description":"This endpoint returns program risk weather periods that meet the following requirements:
  • The object has an ID that matches the value of the {programRiskMitigationId} path parameter.
", "operationId":"/programRiskWeatherPeriod/{programRiskWeatherPeriodId}_find_50", "parameters":[ { "name":"programRiskWeatherPeriodId", "in":"path", "description":"The system-generated identifier of a program risk weather period.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested program risk weather period does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProgramRiskWeatherPeriod", "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriod", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskWeatherPeriod-{programRiskWeatherPeriodId}-get", "x-filename-id":"programriskweatherperiod-programriskweatherperiodid-get" }, "delete":{ "tags":[ "Program Risk Weather Period" ], "summary":"Delete a Program Risk Weather Period", "description":"Send a request to this endpoint to delete a program risk weather period. The application object with an ID value that matches the value of the {programRiskWeatherPeriodId} path parameter will be deleted.", "operationId":"/programRiskWeatherPeriod/{programRiskWeatherPeriodId}_delete_37", "parameters":[ { "name":"programRiskWeatherPeriodId", "in":"path", "description":"The system-generated identifier of a program risk weather period.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"programRiskWeatherPeriod-{programRiskWeatherPeriodId}-delete", "x-filename-id":"programriskweatherperiod-programriskweatherperiodid-delete" } }, "/programRiskWeatherPeriod/code/{periodName}":{ "get":{ "tags":[ "Program Risk Weather Period" ], "summary":"View all Program Risk Weather Periods by Period Name", "description":"This endpoint returns program risk weather periods that meet the following requirements:
  • The object has a name that matches the value of the {periodName} path parameter.
", "operationId":"/programRiskWeatherPeriod/code/{periodName}_findByCode_10", "parameters":[ { "name":"periodName", "in":"path", "description":"The user-specified identifier of a program risk weather period.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested program risk weather period does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskWeatherPeriod-code-{periodName}-get", "x-filename-id":"programriskweatherperiod-code-periodname-get" } }, "/programRiskWeatherPeriod/program/{programId}":{ "get":{ "tags":[ "Program Risk Weather Period" ], "summary":"View all Program Risk Weather Periods by Program ID", "description":"This endpoint returns program risk weather periods that meet the following requirements:
  • The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
", "operationId":"/programRiskWeatherPeriod/program/{programId}_findByProgramId_2", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskWeatherPeriod-program-{programId}-get", "x-filename-id":"programriskweatherperiod-program-programid-get" } }, "/programRiskWeatherPeriod/programRisk/{programRiskId}":{ "get":{ "tags":[ "Program Risk Weather Period" ], "summary":"View a Program Risk Mitigation by Program Risk ID", "description":"This endpoint returns program risk weather periods that meet the following requirements:
  • The object is associated with a program risk with an ID value that matches the value of the {programRiskId} path parameter.
", "operationId":"/programRiskWeatherPeriod/programRisk/{programRiskId}_findByProgramRiskId", "parameters":[ { "name":"programRiskId", "in":"path", "description":"The system-generated identifier of a program risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"The requested program does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskWeatherPeriod-programRisk-{programRiskId}-get", "x-filename-id":"programriskweatherperiod-programrisk-programriskid-get" } }, "/programRiskWeatherPeriod/syncBatch":{ "post":{ "tags":[ "Program Risk Weather Period" ], "summary":"Batch Sync Program Risk Weather Periods", "description":"Send a request to this endpoint to create or update one or more program risk weather periods.", "operationId":"/programRiskWeatherPeriod/syncBatch_syncBatch_32", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any program risk weather period sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more program risk weather period objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriodInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Program_Risk_Weather_Periods_Using_Codes":{ "summary":"Batch Create or Update Program Risk Weather Periods_Using_Codes", "description":"Payload to create or update one or more program risk weather periods using the workspace code, program code, program risk code, period name, period start and finish date, nonworking time definition type, maximum, and minimum nonworking days, and the most probable number of nonworking days, and shape.", "value":[ { "programCode":"Enterprise Initiative", "workspaceCode":"North America", "riskCode":"R2", "periodName":"Cold Waves", "periodStart":"2023-12-03T00:00:00", "periodFinish":"2024-01-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":18, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":15, "shape":"TRIANGLE" } ], "valueSetFlag":true }, "Batch_Create_or_Update_Program_Risk_Weather_Periods":{ "summary":"Batch Create or Update Program Risk Weather Periods", "description":"Payload to create or update one or more program risk weather periods using the program risk ID, period name, period start and finish date, nonworking time definition type, maximum, and minimum nonworking days, and the most probable number of nonworking days, and shape.", "value":[ { "programRiskId":62103, "periodName":"Heat Waves", "periodStart":"2024-03-03T00:00:00", "periodFinish":"2024-04-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":18, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":15, "shape":"TRIANGLE" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"programRiskWeatherPeriod-syncBatch-post", "x-filename-id":"programriskweatherperiod-syncbatch-post" } }, "/projectActuals/changeStatus":{ "put":{ "tags":[ "Project Actuals" ], "summary":"Change Project Actual Status", "description":"Send a request to this endpoint to approve or withdraw the approval of a project actuals.s ", "operationId":"/projectActuals/changeStatus_changeStatus", "parameters":[ { "name":"projectActualsId", "in":"query", "description":"The system-generated identifier of a project actual.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"projectActualsCode", "in":"query", "description":"The user-specified identifier of a project actual.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"status", "in":"query", "description":"That status of the actual.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "CONFIRMED" ] } }, { "name":"approvedDate", "in":"query", "description":"The date that the actual was approved.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Project Actuals with the specified ID does not exist or has been deleted." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectActuals-changeStatus-put", "x-filename-id":"projectactuals-changestatus-put" } }, "/projectActuals":{ "put":{ "tags":[ "Project Actuals" ], "summary":"Update a Project Actual", "description":"Send a request to this endpoint to update a project actual. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/projectActuals_update_36", "requestBody":{ "description":"ProjectActuals to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActualsInput", "$ref":"#/components/schemas/ApiEntityProjectActualsInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Actual_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Project Actual to Assign a Boolean Configured Field", "description":"Payload to update the project actual using the project actual ID and configured field column label and text value.", "value":{ "projectActualsId":310303, "configuredFields":[ { "columnLabel":"PROJECT_STARTED", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Project_Actual_Using_Project_Actual_ID":{ "summary":"Update a Project Actual Using Project Actual ID", "description":"Payload to update the name of a project actual using the project actual ID.", "value":{ "projectActualsId":310303, "projectActualName":"Redesign Concept" }, "valueSetFlag":true }, "Update_a_Project_Actual_by_Removing_a_Configured_Field":{ "summary":"Update a Project Actual by Removing a Configured Field", "description":"Payload to update the project actual using the project actual ID and specifying the action and column label for the configured field to be removed.", "value":{ "projectActualsId":310303, "configuredFields":[ { "action":"DELETE", "columnLabel":"PROJECT_STARTED" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Project Actuals with the specified ID does not exist or has been deleted." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectActuals-put", "x-filename-id":"projectactuals-put" }, "post":{ "tags":[ "Project Actuals" ], "summary":"Create a Project Actual", "description":"Send a request to this endpoint to create a project actual. An application object will be created using the JSON data provided in the request body.", "operationId":"/projectActuals_create_38", "requestBody":{ "description":"A project actual object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActualsInput", "$ref":"#/components/schemas/ApiEntityProjectActualsInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Actual":{ "summary":"Create a Project Actual", "description":"Payload to create a project actual using the project ID, project actual code, and project actual name.", "value":{ "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept" }, "valueSetFlag":true }, "Create_a_Project_Actual_that_includes_Configured_Field_Text":{ "summary":"Create a Project Actual that includes Configured Field Text", "description":"Payload to create a project actual using the project ID, project actual code, project actual name, and values for the configured field which include column name and text value.", "value":{ "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of projectActuals" } ] }, "valueSetFlag":true }, "Create_a_Project_Actual_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Project Actual that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a project actual using the project ID, project actual code, project actual name, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of projectActuals" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Project Actuals with the specified ID does not exist or has been deleted." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActuals", "$ref":"#/components/schemas/ApiEntityProjectActuals", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-post", "x-filename-id":"projectactuals-post" } }, "/projectActuals/batch":{ "put":{ "tags":[ "Project Actuals" ], "summary":"Batch Update Project Actuals", "description":"Send a request to this endpoint to update one or more project actuals. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/projectActuals/batch_updateBatch_32", "requestBody":{ "description":"A list of project actual objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Actuals_to_Assign_Configured_Field":{ "summary":"Batch Update Project Actuals to Assign Configured Field", "description":"Payload to update the name of one or more project actuals using the project actual IDs and configured field column name, column label, column definition ID, and text value.", "value":[ { "projectActualsId":310303, "projectActualName":"Redesign Concept", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of projectActuals" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "projectActualsId":310304, "projectActualName":"All Construction Materials", "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of projectActuals" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true }, "Batch_Update_Project_Actuals_Using_Project_Actual_IDs":{ "summary":"Batch Update Project Actuals Using Project Actual IDs", "description":"Payload to update the name of one or more project actuals using the project actual IDs.", "value":[ { "projectActualsId":310303, "projectActualName":"Redesign Concept" }, { "projectActualsId":310304, "projectActualName":"All Construction Materials" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Project Actuals with the specified ID does not exist or has been deleted." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"projectActuals-batch-put", "x-filename-id":"projectactuals-batch-put" }, "post":{ "tags":[ "Project Actuals" ], "summary":"Batch Create Project Actuals", "description":"Send a request to this endpoint to create one or more project actuals. An application object will be created for each JSON object provided in the request body.", "operationId":"/projectActuals/batch_createBatch_34", "requestBody":{ "description":"A list of project actual objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Actuals_that_include_Configured_Field_Text":{ "summary":"Batch Create Project Actuals that include Configured Field Text", "description":"Payload to create one or more project actuals using the project IDs, project actual codes, project actual names, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of projectActuals" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "projectId":1902903, "projectActualsCode":"BLACK", "projectActualName":"Construction Materials", "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of projectActuals" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true }, "Batch_Create_Project_Actuals":{ "summary":"Batch Create Project Actuals", "description":"Payload to create one or more project actuals using the project IDs, project actual codes, and project actual names.", "value":[ { "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept" }, { "projectId":1902903, "projectActualsCode":"BLACK", "projectActualName":"Construction Materials" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Project Actuals with the specified ID does not exist or has been deleted." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActuals", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-batch-post", "x-filename-id":"projectactuals-batch-post" }, "delete":{ "tags":[ "Project Actuals" ], "summary":"Batch Delete Project Actuals", "description":"Send a request to this endpoint to delete one or more project actuals. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/projectActuals/batch_deleteBatch_34", "requestBody":{ "description":"One or more system-generated identifiers of project actuals.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Project Actuals with the specified ID does not exist or has been deleted." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectActuals-batch-delete", "x-filename-id":"projectactuals-batch-delete" } }, "/projectActuals/{projectActualsId}":{ "get":{ "tags":[ "Project Actuals" ], "summary":"View a Project Actual", "description":"This endpoint returns project actuals that meet the following requirements:
  • The object has an ID that matches the value of the {projectActualsId} path parameter.
", "operationId":"/projectActuals/{projectActualsId}_find_51", "parameters":[ { "name":"projectActualsId", "in":"path", "description":"The system-generated identifier of a project actual.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project actuals do not exist, or you do not have access to them." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActuals", "$ref":"#/components/schemas/ApiEntityProjectActuals", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-{projectActualsId}-get", "x-filename-id":"projectactuals-projectactualsid-get" }, "delete":{ "tags":[ "Project Actuals" ], "summary":"Delete a Project Actual", "description":"Send a request to this endpoint to delete a project actual. The application object with an ID value that matches the value of the {projectActualsId} path parameter will be deleted.", "operationId":"/projectActuals/{projectActualsId}_delete_38", "parameters":[ { "name":"projectActualsId", "in":"path", "description":"The system-generated identifier of a project actual.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Project Actuals with the specified ID does not exist or has been deleted." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectActuals-{projectActualsId}-delete", "x-filename-id":"projectactuals-projectactualsid-delete" } }, "/projectActuals/externallySourced":{ "get":{ "tags":[ "Project Actuals" ], "summary":"View all Integrated Project Actuals", "description":"This endpoint returns all integrated project actuals objects.", "operationId":"/projectActuals/externallySourced_findAllExternallySourced", "responses":{ "204":{ "description":"The requested project actuals data does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedProjectActuals", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-externallySourced-get", "x-filename-id":"projectactuals-externallysourced-get" } }, "/projectActuals/code/{projectActualsCode}":{ "get":{ "tags":[ "Project Actuals" ], "summary":"View a Project Actual by Code", "description":"This endpoint returns project actuals that meet the following requirements:
  • The object has a code that matches the value of the {projectActualsCode} path parameter.
", "operationId":"/projectActuals/code/{projectActualsCode}_findByCode_11", "parameters":[ { "name":"projectActualsCode", "in":"path", "description":"The user-specified identifier of a project actual.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project actuals do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActuals", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-code-{projectActualsCode}-get", "x-filename-id":"projectactuals-code-projectactualscode-get" } }, "/projectActuals/project/{projectId}/code/{projectActualsCode}":{ "get":{ "tags":[ "Project Actuals" ], "summary":"View a Project Actual by Code and Project", "description":"This endpoint returns project actuals that meet the following requirements:
  • The object has a code that matches the value of the {projectActualsCode} path parameter.
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/projectActuals/project/{projectId}/code/{projectActualsCode}_findByCodeAndProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"projectActualsCode", "in":"path", "description":"The user-specified identifier of a project actual.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project actuals do not exist, or you do not have access to them." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActuals", "$ref":"#/components/schemas/ApiEntityProjectActuals", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-project-{projectId}-code-{projectActualsCode}-get", "x-filename-id":"projectactuals-project-projectid-code-projectactualscode-get" } }, "/projectActuals/project/{projectId}":{ "get":{ "tags":[ "Project Actuals" ], "summary":"View all Project Actuals by Project", "description":"This endpoint returns project actuals that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/projectActuals/project/{projectId}_findByProject_11", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project actuals do not exist, or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActuals", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-project-{projectId}-get", "x-filename-id":"projectactuals-project-projectid-get" } }, "/projectActuals/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project Actuals" ], "summary":"View all Project Actuals by Assigned Configured Field Value", "description":"This endpoint returns project actuals that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
", "operationId":"/projectActuals/project/{projectId}/configuredField/{viewColumnName}/{value}_findByUDFValue_3", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"View column name of project actuals configured fields.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"Value of project actuals configured fields.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Project Actuals with the specified ID does not exist or has been deleted." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActuals", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"projectactuals-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/projectActuals/byParent":{ "get":{ "tags":[ "Project Actuals" ], "summary":"View all Project Actuals by Parent", "description":"Send a request to this endpoint to view all project actuals under parent with codes matching the code fields in query parameters.", "operationId":"/projectActuals/byParent_getAllCodeValueByCode_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActuals", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-byParent-get", "x-filename-id":"projectactuals-byparent-get" } }, "/projectActuals/byItemCode":{ "get":{ "tags":[ "Project Actuals" ], "summary":"View a Project Actual by Code and Parent Codes", "description":"Send a request to this endpoint to view a project actual with codes matching the code fields in query parameters.", "operationId":"/projectActuals/byItemCode_getCodeValueByCode_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectActualsCode", "in":"query", "description":"The user-specified identifier of a project actual.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActuals", "$ref":"#/components/schemas/ApiEntityProjectActuals", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-byItemCode-get", "x-filename-id":"projectactuals-byitemcode-get" } }, "/projectActuals/sync":{ "post":{ "tags":[ "Project Actuals" ], "summary":"Integrate Project Actuals Data with an External Data Source", "description":"Send a request to this endpoint to create or update an integrated project actuals data. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/projectActuals/sync_sync_3", "requestBody":{ "description":"The unique identifier of project actual data in an external source.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedProjectActualsInput", "$ref":"#/components/schemas/ApiEntityExternallySourcedProjectActualsInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-sync-post", "x-filename-id":"projectactuals-sync-post" } }, "/projectActuals/syncBatch":{ "post":{ "tags":[ "Project Actuals" ], "summary":"Batch Integrate Project Actuals Data with an External Data Source", "description":"Send a request to this endpoint to create or update one or more integrated project actuals data. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/projectActuals/syncBatch_syncBatch_33", "requestBody":{ "description":"The unique identifier of project actual data in an external source.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedProjectActualsInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Project_Actual_by_Project_Code_and_Workspace_Code":{ "summary":"Create or Update a Project Actual by Project Code and Workspace Code", "description":"Payload to create or update a project actual using the project code, workspace code, project actual code, and project actual name.", "value":[ { "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept" } ], "valueSetFlag":true }, "Create_or_Update_a_Project_Actual_to_Assign_a_Configured_Field":{ "summary":"Create or Update a Project Actual to Assign a Configured Field", "description":"Payload to create or update a project actual using the project ID, project actual code, project actual ID, project actual name, and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept", "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of projectActuals" }, { "columnDefinationId":60145, "textValue":"Y" } ] }, { "projectActualsId":310304, "projectActualName":"All Construction Materials", "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of projectActuals" }, { "columnDefinationId":60245, "numberValue":2 } ] } ], "valueSetFlag":true }, "Create_or_Update_a_Project_Actual_by_Project_ID":{ "summary":"Create or Update a Project Actual by Project ID", "description":"Payload to create or update a project actual using the project ID, project actual code, and project actual name.", "value":[ { "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-syncBatch-post", "x-filename-id":"projectactuals-syncbatch-post" } }, "/projectActuals/sync/batch":{ "post":{ "tags":[ "Project Actuals" ], "summary":"Batch Sync Project Actuals", "description":"Send a request to this endpoint to create or update one or more project actuals.", "operationId":"/projectActuals/sync/batch_syncBatch_34", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any project actuals sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more project actuals objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Project_Actual_by_Project_Code_and_Workspace_Code":{ "summary":"Create or Update a Project Actual by Project Code and Workspace Code", "description":"Payload to create or update a project actual using the project code, workspace code, project actual code, and project actual name.", "value":[ { "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept" } ], "valueSetFlag":true }, "Create_or_Update_a_Project_Actual_by_Project_ID":{ "summary":"Create or Update a Project Actual by Project ID", "description":"Payload to create or update a project actual using the project ID, project actual code, and project actual name.", "value":[ { "projectId":1902903, "projectActualsCode":"RED", "projectActualName":"Design Concept" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActuals-sync-batch-post", "x-filename-id":"projectactuals-sync-batch-post" } }, "/projectActualsLineItem":{ "put":{ "tags":[ "Project Actuals Line Item" ], "summary":"Update a Project Actuals Line Item ", "description":"Send a request to this endpoint to update a project actual line item.", "operationId":"/projectActualsLineItem_update_37", "requestBody":{ "description":"A project actual line item object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActualsLineItemInput", "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Actuals_Line_Item_Using_Project_Actuals_Line_Item_ID":{ "summary":"Update a Project Actuals Line Item Using Project Actuals Line Item ID", "description":"Payload to update the total project actuals cost amount of a project actual line item using project the actuals line item ID.", "value":{ "projectActualsLineItemId":268304, "projectActualsLineItemCost":{ "totalProjectActuals":25000 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectActualsLineItem-put", "x-filename-id":"projectactualslineitem-put" }, "post":{ "tags":[ "Project Actuals Line Item" ], "summary":"Create a Project Actuals Line Item", "description":"Send a request to this endpoint to create a project actual line item.", "operationId":"/projectActualsLineItem_create_39", "requestBody":{ "description":"A project actual line item object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActualsLineItemInput", "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Actuals_Line_Item":{ "summary":"Create a Project Actuals Line Item", "description":"Payload to create a project actuals line item using the project actuals ID, name, and total project actuals cost amount.", "value":{ "projectActualsId":310304, "name":"Bricks", "projectActualsLineItemCost":{ "totalProjectActuals":20000 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActualsLineItem", "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-post", "x-filename-id":"projectactualslineitem-post" } }, "/projectActualsLineItem/batch":{ "put":{ "tags":[ "Project Actuals Line Item" ], "summary":"Batch Update Project Actuals Line Items", "description":"Send a request to this endpoint to update one or more project actual line items.", "operationId":"/projectActualsLineItem/batch_updateBatch_33", "requestBody":{ "description":"A project actual line item object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Actuals_Line_Items_Using_Project_Actuals_Line_Item_IDs":{ "summary":"Batch Update Project Actuals Line Items Using Project Actuals Line Item IDs", "description":"Payload to update the total project actuals cost amount of one or more project actual line items using the project actuals line item IDs.", "value":[ { "projectActualsLineItemId":268304, "projectActualsLineItemCost":{ "totalProjectActuals":25000 } }, { "projectActualsLineItemId":268305, "projectActualsLineItemCost":{ "totalProjectActuals":55000 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"projectActualsLineItem-batch-put", "x-filename-id":"projectactualslineitem-batch-put" }, "post":{ "tags":[ "Project Actuals Line Item" ], "summary":"Batch Create Project Actuals Line Items", "description":"Send a request to this endpoint to create one or more project actual line items.", "operationId":"/projectActualsLineItem/batch_createBatch_35", "requestBody":{ "description":"One or more project actual line items.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Actuals_Line_Items":{ "summary":"Batch Create Project Actuals Line Items", "description":"Payload to create one or more project actuals line items using the project actuals IDs, names, and total project actuals cost amounts.", "value":[ { "projectActualsId":310304, "name":"Bricks", "projectActualsLineItemCost":{ "totalProjectActuals":20000 } }, { "projectActualsId":310304, "name":"Cement", "projectActualsLineItemCost":{ "totalProjectActuals":50000 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-batch-post", "x-filename-id":"projectactualslineitem-batch-post" }, "delete":{ "tags":[ "Project Actuals Line Item" ], "summary":"Batch Delete Project Actuals Line Items ", "description":"Send a request to this endpoint to delete one or more project actual line items.", "operationId":"/projectActualsLineItem/batch_deleteBatch_35", "requestBody":{ "description":"One or more system-generated identifiers of project actual line items.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectActualsLineItem-batch-delete", "x-filename-id":"projectactualslineitem-batch-delete" } }, "/projectActualsLineItem/{projectActualsLineItemId}":{ "get":{ "tags":[ "Project Actuals Line Item" ], "summary":"View a Project Actual Line Item", "description":"This endpoint returns project actual line items that meet the following requirements:
  • The object has an ID that matches the value of the {projectActualsLineItemId} path parameter.
", "operationId":"/projectActualsLineItem/{projectActualsLineItemId}_find_52", "parameters":[ { "name":"projectActualsLineItemId", "in":"path", "description":"The system-generated identifier of the project actual line item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project actuals line items do not exist or you do not have access to them." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActualsLineItem", "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-{projectActualsLineItemId}-get", "x-filename-id":"projectactualslineitem-projectactualslineitemid-get" }, "delete":{ "tags":[ "Project Actuals Line Item" ], "summary":"Delete a Project Actuals Line Item ", "description":"Send a request to this endpoint to delete a project actual line item. The application object with an ID value that matches the value of the {projectActualsLineItemId} path parameter will be deleted.", "operationId":"/projectActualsLineItem/{projectActualsLineItemId}_delete_39", "parameters":[ { "name":"projectActualsLineItemId", "in":"path", "description":"The system-generated identifier of a project actual line item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectActualsLineItem-{projectActualsLineItemId}-delete", "x-filename-id":"projectactualslineitem-projectactualslineitemid-delete" } }, "/projectActualsLineItem/externallySourced":{ "get":{ "tags":[ "Project Actuals Line Item" ], "summary":"View all Integrated Project Actuals Line Items", "description":"This endpoint returns all integrated project actuals line item objects.", "operationId":"/projectActualsLineItem/externallySourced_findAllExternallySourced_1", "responses":{ "204":{ "description":"The requested project actuals line item does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedProjectActualsLineItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-externallySourced-get", "x-filename-id":"projectactualslineitem-externallysourced-get" } }, "/projectActualsLineItem/code/{projectActualsLineItemCode}":{ "get":{ "tags":[ "Project Actuals Line Item" ], "summary":"View a Project Actuals Line Item by Code", "description":"This endpoint returns project actual line items that meet the following requirements:
  • The object has a code that matches the value of the {projectActualsLineItemCode} path parameter.
", "operationId":"/projectActualsLineItem/code/{projectActualsLineItemCode}_findByCode_12", "parameters":[ { "name":"projectActualsLineItemCode", "in":"path", "description":"The user-specified identifier of a project actual line item.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project actuals line items do not exist or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-code-{projectActualsLineItemCode}-get", "x-filename-id":"projectactualslineitem-code-projectactualslineitemcode-get" } }, "/projectActualsLineItem/projectActual/{projectActualsId}/code/{projectActualsLineItemCode}":{ "get":{ "tags":[ "Project Actuals Line Item" ], "summary":"View a Project Actuals Line Item by Code and Project Actual ID", "description":"This endpoint returns project actual line items that meet the following requirements:
  • The object has a code that matches the value of the {projectActualsLineItemCode} path parameter.
  • The object is associated with a project actual with an ID value that matches the value of the {projectActualsId} path parameter.
", "operationId":"/projectActualsLineItem/projectActual/{projectActualsId}/code/{projectActualsLineItemCode}_findByCodeAndProjectActual", "parameters":[ { "name":"projectActualsId", "in":"path", "description":"The system-generated identifier of a project actual.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"projectActualsLineItemCode", "in":"path", "description":"The user-specified identifier of a project actual line item.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project actuals line items do not exist or you do not have access to them." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActualsLineItem", "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-projectActual-{projectActualsId}-code-{projectActualsLineItemCode}-get", "x-filename-id":"projectactualslineitem-projectactual-projectactualsid-code-projectactualslineitemcode-get" } }, "/projectActualsLineItem/projectActuals/{projectActualsId}":{ "get":{ "tags":[ "Project Actuals Line Item" ], "summary":"View all Project Actual Line Items by Project Actual", "description":"This endpoint returns project actual line items that meet the following requirements:
  • The object is associated with a project actual with an ID value that matches the value of the {projectActualsId} path parameter.
", "operationId":"/projectActualsLineItem/projectActuals/{projectActualsId}_findByProjectActuals", "parameters":[ { "name":"projectActualsId", "in":"path", "description":"The system-generated identifier of a project actual.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project actuals line items do not exist or you do not have access to them." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-projectActuals-{projectActualsId}-get", "x-filename-id":"projectactualslineitem-projectactuals-projectactualsid-get" } }, "/projectActualsLineItem/byParent":{ "get":{ "tags":[ "Project Actuals Line Item" ], "summary":"View all Project Actual Line Items by Parent", "description":"Send a request to this endpoint to view all project actual line items under parent with codes matching the code fields in query parameters.", "operationId":"/projectActualsLineItem/byParent_getAllCodeValueByCode_2", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectActualsCode", "in":"query", "description":"The user-specified identifier of a project actual.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-byParent-get", "x-filename-id":"projectactualslineitem-byparent-get" } }, "/projectActualsLineItem/byItemCode":{ "get":{ "tags":[ "Project Actuals Line Item" ], "summary":"View a Project Actual Line Item by Code and Parent Codes", "description":"Send a request to this endpoint to view a project actual line item with codes matching the code fields in query parameters.", "operationId":"/projectActualsLineItem/byItemCode_getCodeValueByCode_2", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectActualsCode", "in":"query", "description":"The user-specified identifier of a project actual.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectActualsLineItemCode", "in":"query", "description":"The user-specified identifier of a project actual line item.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectActualsLineItem", "$ref":"#/components/schemas/ApiEntityProjectActualsLineItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-byItemCode-get", "x-filename-id":"projectactualslineitem-byitemcode-get" } }, "/projectActualsLineItem/sync":{ "post":{ "tags":[ "Project Actuals Line Item" ], "summary":"Integrate a Project Actuals Line Item with an External Data Source", "description":"Send a request to this endpoint to create or update an integrated a project actuals line item. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/projectActualsLineItem/sync_sync_4", "requestBody":{ "description":"The unique identifier of line item data in an external source.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedProjectActualsLineItemInput", "$ref":"#/components/schemas/ApiEntityExternallySourcedProjectActualsLineItemInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-sync-post", "x-filename-id":"projectactualslineitem-sync-post" } }, "/projectActualsLineItem/syncBatch":{ "post":{ "tags":[ "Project Actuals Line Item" ], "summary":"Batch Integrate Project Actuals Line Items with an External Data Source", "description":"Send a request to this endpoint to create or update an integrated project actuals line items. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/projectActualsLineItem/syncBatch_syncBatch_35", "requestBody":{ "description":"One or more unique identifiers of line item data in an external source.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedProjectActualsLineItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Project_Actuals_Line_Item_Using_Project_Actuals_ID":{ "summary":"Create or Update a Project Actuals Line Item Using Project Actuals ID", "description":"Payload to create or update a project actuals line item using the project actuals ID, name, and total project actuals cost amount.", "value":[ { "projectActualsId":310304, "name":"Bricks", "projectActualsLineItemCost":{ "totalProjectActuals":20000 } } ], "valueSetFlag":true }, "Create_or_Update_a_Project_Actuals_Line_Item_Using_Codes":{ "summary":"Create or Update a Project Actuals Line Item Using Codes", "description":"Payload to create or update a project actuals line item using the project actuals code, project code, workspace code, name, and total project actuals cost amount.", "value":[ { "projectActualsCode":"RED", "projectCode":"New Town - City Mall", "workspaceCode":"North America", "name":"Bricks", "projectActualsLineItemCost":{ "totalProjectActuals":20000 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-syncBatch-post", "x-filename-id":"projectactualslineitem-syncbatch-post" } }, "/projectActualsLineItem/sync/batch":{ "post":{ "tags":[ "Project Actuals Line Item" ], "summary":"Batch Sync Project Actuals Line Items", "description":"Send a request to this endpoint to create or update one or more project actuals line item.", "operationId":"/projectActualsLineItem/sync/batch_syncBatch_36", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any project actuals line items sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more project actuals line items.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Project_Actuals_Line_Item_Using_Project_Actuals_ID":{ "summary":"Create or Update a Project Actuals Line Item Using Project Actuals ID", "description":"Payload to create or update a project actuals line item using the project actuals ID, name, and total project actuals cost amount.", "value":[ { "projectActualsId":310304, "name":"Bricks", "projectActualsLineItemCost":{ "totalProjectActuals":20000 } } ], "valueSetFlag":true }, "Create_or_Update_a_Project_Actuals_Line_Item_Using_Codes":{ "summary":"Create or Update a Project Actuals Line Item Using Codes", "description":"Payload to create or update a project actuals line item using the project actuals code, project code, workspace code, name, and total project actuals cost amount.", "value":[ { "projectActualsCode":"RED", "projectCode":"New Town - City Mall", "workspaceCode":"North America", "name":"Bricks", "projectActualsLineItemCost":{ "totalProjectActuals":20000 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectActualsLineItem-sync-batch-post", "x-filename-id":"projectactualslineitem-sync-batch-post" } }, "/project/assignUser":{ "post":{ "tags":[ "Project" ], "summary":"Assign Permission Profiles To User", "description":"Use this endpoint to assign project permission profiles to multiple user.", "operationId":"/project/assignUser_assignUser_5", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when validating any user permission profile sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with project and user profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectUserPermissions", "$ref":"#/components/schemas/ApiEntityProjectUserPermissions", "exampleSetFlag":false }, "examples":{ "Assign_Project_Permission_Profiles_to_Multiple_Users_Using_IDs":{ "summary":"Assign Project Permission Profiles to Multiple Users Using IDs", "description":"Payload to assign project permission to multiple users using mandatory fields such as project ID, user name, and project profile ID.", "value":{ "projectId":2225001, "profiles":[ { "userName":"manager@example.com", "projectProfileId":"3" }, { "userName":"supervisor@example.com", "projectProfileId":"13" } ] }, "valueSetFlag":true }, "Assign_Project_Permission_Profiles_to_Multiple_Users_Using_Codes":{ "summary":"Assign Project Permission Profiles to Multiple Users Using Codes", "description":"Payload to assign project permission to multiple users using project code, workspace ID, profiles such as user name, project profile ID, file profile ID, custom log profile ID, and report profile ID.", "value":{ "workspaceId":726701, "projectCode":"New Town - City Mall", "profiles":[ { "userName":"manager@example.com", "projectProfileId":"3", "fileProfileId":"6", "customLogProfileId":"9", "reportProfileId":"7" }, { "userName":"supervisor@example.com", "projectProfileId":"45", "fileProfileId":"6", "customLogProfileId":"9", "reportProfileId":"43" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityProjectUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-assignUser-post", "x-filename-id":"project-assignuser-post" } }, "/project/assignUserGroup":{ "post":{ "tags":[ "Project" ], "summary":"Assign Permission Profiles To User Group", "description":"Use this endpoint to assign project permission profiles to multiple user groups.", "operationId":"/project/assignUserGroup_assignUserGroup", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when validating any user permission profile sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with project and user group profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectUserGroupPermissionInput", "$ref":"#/components/schemas/ApiEntityProjectUserGroupPermissionInput", "exampleSetFlag":false }, "examples":{ "Assign_Project_Permission_Profiles_to_Multiple_User_Groups_Using_Code":{ "summary":"Assign Project Permission Profiles to Multiple User Groups Using Code", "description":"Payload to assign project permission profiles to multiple user groups using workspace code, project code, and profiles.", "value":{ "workspaceCode":"Deep_ws", "projectCode":"PRoj", "profiles":[ { "userGroupId":6301, "reportProfileId":17, "projectProfileId":3, "portfolioProfileId":39, "fileProfileId":36, "customLogProfileId":19 }, { "userGroupId":20389, "reportProfileId":17, "projectProfileId":3, "portfolioProfileId":39, "fileProfileId":36, "customLogProfileId":19 } ] }, "valueSetFlag":true }, "Assign_project_Permission_Profiles_to_Multiple_User_Groups_Using_ID":{ "summary":"Assign Project Permission Profiles to Multiple User Groups Using ID", "description":"Payload to assign project permission profiles to multiple user groups using projectId and profiles.", "value":{ "workspaceId":2344, "projectId":3234, "profiles":[ { "userGroupId":6301, "reportProfileId":17, "projectProfileId":3, "portfolioProfileId":39, "fileProfileId":36, "customLogProfileId":19 }, { "userGroupId":20389, "reportProfileId":17, "projectProfileId":3, "portfolioProfileId":39, "fileProfileId":36, "customLogProfileId":19 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityProjectUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-assignUserGroup-post", "x-filename-id":"project-assignusergroup-post" } }, "/project/assignUsersToGroup":{ "post":{ "tags":[ "Project" ], "summary":"Assign Users To User Group", "description":"Use this endpoint to assign users to user group at given project.", "operationId":"/project/assignUsersToGroup_assignUsersToGroup", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user to group assignment/removal sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User group input with project and user details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectUserGroupAssignmentInput", "$ref":"#/components/schemas/ApiEntityProjectUserGroupAssignmentInput", "exampleSetFlag":false }, "examples":{ "Assign_User_To_User_Group_At _project_Using_IDs":{ "summary":"Assign User To User Group At Project Using IDs", "description":"Payload to assign user to user group at project using project ID, user group ID, and user names.", "value":[ { "workspaceId":"726701", "projectId":3423, "userGroupId":454701, "userNames":[ "Baker@example.com", "Adams@example.com" ] } ], "valueSetFlag":true }, "Assign_User_To_User_Group_At_project_Using_Code":{ "summary":"Assign User To User Group At Project Using Code", "description":"Payload to assign user to user group at project using project code, workspace code, user group ID, and user names.", "value":[ { "workspaceCode":"Test", "projectCode":"asdf", "userGroupId":454701, "userNames":[ "Baker@example.com", "Adams@example.com" ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityProjectUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-assignUsersToGroup-post", "x-filename-id":"project-assignuserstogroup-post" } }, "/project":{ "put":{ "tags":[ "Project" ], "summary":"Update a Project", "description":"Send a request to this endpoint to update a project. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/project_update_38", "requestBody":{ "description":"The project to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectInput", "$ref":"#/components/schemas/ApiEntityProjectInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Using_Project_ID":{ "summary":"Update a Project Using Project ID", "description":"Payload to update the name of a project using project ID.", "value":{ "projectId":1001, "projectCode":"New Town - City Mall Development", "projectName":"New Town - City Mall Development" }, "valueSetFlag":true }, "Update_a_Project_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Project by Assigning Multiple Code Values Using IDs", "description":"Payload to update a project using project ID and codeValuesProject fields such as code value ID and code type ID.", "value":{ "projectId":2922001, "codeValuesProject":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Update_a_Project_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Project by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update a project using project ID and codeValuesProject fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "projectId":2922001, "codeValuesProject":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Update_a_Project_by_Removing_a_Configured_Field":{ "summary":"Update a Project by Removing a Configured Field", "description":"Payload to update a project using project ID and specifying the action and column label for the configured field to be removed.", "value":{ "projectId":2922001, "configuredFields":[ { "action":"DELETE", "columnLabel":"PROJECT_STARTED" } ] }, "valueSetFlag":true }, "Update_a_Project_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Project to Assign a Boolean Configured Field", "description":"Payload to update a project using project ID and configured field column label and text value.", "value":{ "projectId":2922001, "configuredFields":[ { "columnLabel":"PROJECT_STARTED", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Project_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Project by Assigning Code Values Using Codes", "description":"Payload to update a project using workspace code, project code, and codeValuesProject fields such as code value code and code type code.", "value":{ "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "codeValuesProject":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_Project_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Project by Assigning Code Values Using IDs", "description":"Payload to update a project using project ID and codeValuesProject fields such as code value ID and code type ID.", "value":{ "projectId":2922001, "codeValuesProject":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"project-put", "x-filename-id":"project-put" }, "post":{ "tags":[ "Project" ], "summary":"Create a Project", "description":"Send a request to this endpoint to create a project. An application object will be created using the JSON data provided in the request body.", "operationId":"/project_create_40", "requestBody":{ "description":"The project to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectInput", "$ref":"#/components/schemas/ApiEntityProjectInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project":{ "summary":"Create a Project", "description":"Payload to create a project using workspace ID, project code, project name, and values for the configured field which include column name and text value.", "value":{ "workspaceId":10001, "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall" }, "valueSetFlag":true }, "Create_a_Project_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Project by Assigning Multiple Code Values Using IDs", "description":"Payload to create a project using workspace code, project code, project name, and codeValuesProject fields such as code value ID and code type ID.", "value":{ "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "workspaceCode":"Asia", "codeValuesProject":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Project_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Project by Assigning Code Values Using Codes", "description":"Payload to create a project using workspace code, project code, project name, and codeValuesProject fields such as code value code and code type code.", "value":{ "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "workspaceCode":"Asia", "codeValuesProject":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Create_a_Project_that_includes_Configured_Field_Text":{ "summary":"Create a Project that includes Configured Field Text", "description":"Payload to create a project using workspace ID, project code, project name, and values for the configured field which include column name and text value.", "value":{ "workspaceId":10001, "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "configuredFields":[ { "columnName":"ProjectNotes", "textValue":"Project delayed due to dependency" } ] }, "valueSetFlag":true }, "Create_a_Project_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Project that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a project using workspace ID, project code, project name, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "workspaceId":10001, "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "configuredFields":[ { "columnName":"ProjectNotes", "textValue":"Project delayed due to dependency" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Project_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Project by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a project using workspace code, project code, project name, and codeValuesProject fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "workspaceCode":"Asia", "codeValuesProject":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Create_a_Project_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create a Project by Assigning Code Values Using IDs", "description":"Payload to create a project using workspace code, project code, project name, and codeValuesProject fields such as code value ID and code type ID.", "value":{ "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "workspaceCode":"Asia", "codeValuesProject":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProject", "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-post", "x-filename-id":"project-post" } }, "/project/batch":{ "put":{ "tags":[ "Project" ], "summary":"Batch Update Projects", "description":"Send a request to this endpoint to update one or more projects. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/project/batch_updateBatch_34", "requestBody":{ "description":"The projects to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Projects_Using_Project_IDs":{ "summary":"Batch Update Projects Using Project IDs", "description":"Payload to update the name of one or more projects using project IDs.", "value":[ { "projectId":1001, "projectCode":"New Town - City Mall Development", "projectName":"New Town - City Mall Development" }, { "projectId":1002, "projectCode":"Delhi High Speed Rail Corridor", "projectName":"Delhi High Speed Rail Corridor" } ], "valueSetFlag":true }, "Batch_Update_Projects_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Projects by Assigning Code Values Using Codes or IDs", "description":"Payload to update the projects using project ID and codeValuesProject fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "codeValuesProject":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "projectId":436446 }, { "codeValuesProject":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "projectId":436447 } ], "valueSetFlag":true }, "Batch_Update_Projects_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Projects by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the projects using project ID and codeValuesProject fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesProject":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectId":436446 }, { "codeValuesProject":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectId":436447 } ], "valueSetFlag":true }, "Batch_Update_Projects_to_Assign_Configured_Field":{ "summary":"Batch Update Projects to Assign Configured Field", "description":"Payload to update the projects using project ID and configured field column name, column label, column definition ID, and text value.", "value":[ { "configuredFields":[ { "columnName":"ProjectNotes", "textValue":"Project delayed due to dependency" }, { "columnDefinationId":60045, "textValue":"N" } ], "projectId":436446 }, { "configuredFields":[ { "columnLabel":"PLANNER_NOTES", "textValue":"Project should be started in this month" }, { "columnDefinationId":60045, "textValue":"Y" } ], "projectId":436447 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"project-batch-put", "x-filename-id":"project-batch-put" }, "post":{ "tags":[ "Project" ], "summary":"Batch Create Projects", "description":"Send a request to this endpoint to create one or more projects. An application object will be created for each JSON object provided in the request body.. If given payload has cashflows, then this API allows 500 projects to be created. If given payload doesn't have cashflows, then this API allows 2000 projects to be created.", "operationId":"/project/batch_createBatch_36", "requestBody":{ "description":"The projects to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Projects":{ "summary":"Batch Create Projects", "description":"Payload to create one or more projects using workspace ID, project code, and project name.", "value":[ { "workspaceId":10001, "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall" }, { "workspaceId":10002, "projectCode":"Delhi High Speed Rail Corridor", "projectName":"Delhi High Speed Rail Corridor" } ], "valueSetFlag":true }, "Batch_Create_Projects_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Projects by Assigning Code Values Using Codes", "description":"Payload to create projects using workspace code, project code, project name, and codeValuesProject fields such as code value code and code type code.", "value":[ { "codeValuesProject":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ], "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "workspaceCode":"Asia" }, { "codeValuesProject":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "projectCode":"Delhi High Speed Rail Corridor", "projectName":"Delhi High Speed Rail Corridor", "workspaceCode":"Asia" } ], "valueSetFlag":true }, "Batch_Create_Projects_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Projects by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create projects using workspace code, project code, project name, and codeValuesProject fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesProject":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "workspaceCode":"Asia" }, { "codeValuesProject":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectCode":"Delhi High Speed Rail Corridor", "projectName":"Delhi High Speed Rail Corridor", "workspaceCode":"Asia" } ], "valueSetFlag":true }, "Batch_Create_Projects_that_include_Configured_Field_Text":{ "summary":"Batch Create Projects that include Configured Field Text", "description":"Payload to create one or more projects using workspace ID, project code, project name, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "workspaceId":10001, "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "configuredFields":[ { "columnName":"ProjectNotes", "textValue":"Project delayed due to dependency" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "workspaceId":10002, "projectCode":"Delhi High Speed Rail Corridor", "projectName":"Delhi High Speed Rail Corridor", "configuredFields":[ { "columnLabel":"PLANNER_NOTES", "textValue":"Project should be started in this month" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-batch-post", "x-filename-id":"project-batch-post" }, "delete":{ "tags":[ "Project" ], "summary":"Batch Delete Projects", "description":"Send a request to this endpoint to delete one or more projects. Objects with ID values that match the values provided in the request body will be deleted. ", "operationId":"/project/batch_deleteBatch_36", "parameters":[ { "name":"cascadeOnDelete", "in":"query", "description":"Boolean value(true) for cascade delete project.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"IDs of the projects to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful cascade delete operation.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-batch-delete", "x-filename-id":"project-batch-delete" } }, "/project/{projectId}":{ "get":{ "tags":[ "Project" ], "summary":"View a Project", "description":"This endpoint returns projects that meet the following requirements:
  • The object has an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/project/{projectId}_find_53", "parameters":[ { "name":"projectId", "in":"path", "description":"ID of the project to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProject", "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "404":{ "description":"The requested project does not exist, or you do not have access to it." } }, "x-internal-id":"project-{projectId}-get", "x-filename-id":"project-projectid-get" }, "delete":{ "tags":[ "Project" ], "summary":"Delete a Project", "description":"Send a request to this endpoint to delete a project. The application object with an ID value that matches the value of the {projectId} path parameter will be deleted.", "operationId":"/project/{projectId}_delete_40", "parameters":[ { "name":"projectId", "in":"path", "description":"ID of the project to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"cascadeOnDelete", "in":"query", "description":"Boolean value(true) for cascade delete project.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"Invalid input for the Project service." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful cascade delete operation.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-{projectId}-delete", "x-filename-id":"project-projectid-delete" } }, "/project/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Project" ], "summary":"View all Projects by Assigned Code Value", "description":"This endpoint returns projects that meet the following requirements:
  • The object is assigned a code type that matches the value of the {codeTypeId} path parameter and a code value that matches the value of the {codeValueCode} path parameter.
", "operationId":"/project/codeType/{codeTypeId}/codeValue/{codeValueCode}_findByCodeValue_2", "parameters":[ { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"project-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/project/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project" ], "summary":"View all Projects by Assigned Configured Field Value", "description":"This endpoint returns projects that meet the following requirements:
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
", "operationId":"/project/configuredField/{viewColumnName}/{value}_findByUDFValue_4", "parameters":[ { "name":"viewColumnName", "in":"path", "description":"The name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"project-configuredfield-viewcolumnname-value-get" } }, "/project/externallySourced":{ "get":{ "tags":[ "Project" ], "summary":"View all Integrated Projects", "description":"This endpoint returns all integrated project objects.", "operationId":"/project/externallySourced_findForSource_3", "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-externallySourced-get", "x-filename-id":"project-externallysourced-get" } }, "/project/code/{projectCode}":{ "get":{ "tags":[ "Project" ], "summary":"View all Projects by Project Code", "description":"This endpoint returns projects that meet the following requirements:
  • The object has a code that matches the value of the {projectCode} path parameter.
", "operationId":"/project/code/{projectCode}_findProjectByCode", "parameters":[ { "name":"projectCode", "in":"path", "description":"The user-specified identifier of a project.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-code-{projectCode}-get", "x-filename-id":"project-code-projectcode-get" } }, "/project/byItemCode":{ "get":{ "tags":[ "Project" ], "summary":"View a Project by Code and Parent Code", "description":"Send a request to this endpoint to view a project with codes matching the code fields in query parameters.", "operationId":"/project/byItemCode_findProjectByCode_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProject", "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-byItemCode-get", "x-filename-id":"project-byitemcode-get" } }, "/project/workspace/{workspaceId}/code/{projectCode}":{ "get":{ "tags":[ "Project" ], "summary":"View a Project by Code and Workspace", "description":"This endpoint returns projects that meet the following requirements:
  • The object has a code that matches the value of the {projectCode} path parameter.
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/project/workspace/{workspaceId}/code/{projectCode}_findProjectByCodeAndWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"WorkspaceID of the project to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"projectCode", "in":"path", "description":"Code of the project to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProject", "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-workspace-{workspaceId}-code-{projectCode}-get", "x-filename-id":"project-workspace-workspaceid-code-projectcode-get" } }, "/project/name/{projectName}":{ "get":{ "tags":[ "Project" ], "summary":"View all Projects by Name", "description":"This endpoint returns projects that meet the following requirements:
  • The object has a name that matches the value of the {projectName} path parameter.
", "operationId":"/project/name/{projectName}_findProjectByName", "parameters":[ { "name":"projectName", "in":"path", "description":"Name of the project to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-name-{projectName}-get", "x-filename-id":"project-name-projectname-get" } }, "/project/nameLike/{projectName}":{ "get":{ "tags":[ "Project" ], "summary":"View all Projects by Specified Name Pattern", "description":"Send a request to this endpoint to get a list of projects that contain the given project name pattern. A pattern must include part of a project name and may include any wild card characters.", "operationId":"/project/nameLike/{projectName}_findProjectByNameAndWorkspace", "parameters":[ { "name":"projectName", "in":"path", "description":"Name of the project to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-nameLike-{projectName}-get", "x-filename-id":"project-namelike-projectname-get" } }, "/project/image/{projectId}":{ "get":{ "tags":[ "Project" ], "summary":"View a Project Image", "description":"This endpoint returns project images that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/project/image/{projectId}_findProjectImage", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectImage", "$ref":"#/components/schemas/ApiEntityProjectImage", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-image-{projectId}-get", "x-filename-id":"project-image-projectid-get" } }, "/project/permissionSets":{ "get":{ "tags":[ "Project" ], "summary":"View Available Permission Sets for Project", "description":"Send a request to this endpoint to view the available permission sets for the provided project.", "operationId":"/project/permissionSets_getPermissionSets_5", "parameters":[ { "name":"projectId", "in":"query", "description":"ID of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"Workspace code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Error loading permission sets in the given project." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPermissionSets", "$ref":"#/components/schemas/ApiEntityPermissionSets", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-permissionSets-get", "x-filename-id":"project-permissionsets-get" } }, "/project/byParent":{ "get":{ "tags":[ "Project" ], "summary":"View all Projects by Parent Code", "description":"Send a request to this endpoint to view all projects under parent with codes matching the code fields in query parameters.", "operationId":"/project/byParent_getProjectByWorkspaceCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the projects have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-byParent-get", "x-filename-id":"project-byparent-get" } }, "/project/workspace/{workspaceId}":{ "get":{ "tags":[ "Project" ], "summary":"View all Projects by Workspace ", "description":"This endpoint returns projects that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/project/workspace/{workspaceId}_getProjectByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"WorkspaceID of the project to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-workspace-{workspaceId}-get", "x-filename-id":"project-workspace-workspaceid-get" } }, "/project/notebookTopic/workspace/{workspaceId}":{ "get":{ "tags":[ "Project" ], "summary":"View Project Notebook Topics", "description":"Send a request to this endpoint to view project notebook topics for all project under the workspace matching the path parameter {workspaceId}.", "operationId":"/project/notebookTopic/workspace/{workspaceId}_getProjectNotebookTopicsByProject", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-notebookTopic-workspace-{workspaceId}-get", "x-filename-id":"project-notebooktopic-workspace-workspaceid-get" } }, "/project/userGroups/permissionSets":{ "get":{ "tags":[ "Project" ], "summary":"View Permission Sets and Users Assigned to User Group for Project", "description":"Send a request to this endpoint to view permission sets and users assigned to a user group at the provided project.", "operationId":"/project/userGroups/permissionSets_getUserGroupPermissionSets", "parameters":[ { "name":"projectId", "in":"query", "description":"ID of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"Workspace code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Error loading permission sets and users assigned to a user group in the given project." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUserGroupsPermissionAssignmentsProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-userGroups-permissionSets-get", "x-filename-id":"project-usergroups-permissionsets-get" } }, "/project/userGroups":{ "get":{ "tags":[ "Project" ], "summary":"View User Groups for Project", "description":"Send a request to this endpoint to view the user groups accessible for the provided project.", "operationId":"/project/userGroups_getUserGroups", "parameters":[ { "name":"projectId", "in":"query", "description":"ID of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"Workspace code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"inheritedUsers", "in":"query", "description":"Enabling this boolean flag will include all inherited users assigned to the user groups.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"Error loading user groups in the given project." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityUserGroups", "$ref":"#/components/schemas/ApiEntityUserGroups", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-userGroups-get", "x-filename-id":"project-usergroups-get" } }, "/project/users/permissionSets":{ "get":{ "tags":[ "Project" ], "summary":"View Permission Sets assigned to all users at Project", "description":"Send a request to this endpoint to view the permission sets assigned to all the users at the provided project.", "operationId":"/project/users/permissionSets_getUserPermissionSets", "parameters":[ { "name":"projectId", "in":"query", "description":"ID of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"Workspace code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"Project code of the project to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Error loading permission sets assigned to all users in the given project." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUserPermissionAssignmentsProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-users-permissionSets-get", "x-filename-id":"project-users-permissionsets-get" } }, "/project/baseline/data":{ "get":{ "tags":[ "Project" ], "summary":"View a Project by Baseline", "description":"Send a request to this endpoint to view the project by baseline matching the code fields in query parameters.", "operationId":"/project/baseline/data_loadProjectsByBaseline", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"baselineName", "in":"query", "description":"The user-specified identifier of a project baseline.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"baselineType", "in":"query", "description":"Identifies the official and unofficial baselines. Default value is ORIGINAL.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CURRENT", "OTHER", "USER_BASELINE_1", "USER_BASELINE_2", "USER_BASELINE_3" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityBaselineProject", "$ref":"#/components/schemas/ApiEntityBaselineProject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-baseline-data-get", "x-filename-id":"project-baseline-data-get" } }, "/project/removeUsers":{ "post":{ "tags":[ "Project" ], "summary":"Remove Users Assigned to a Project", "description":"Send a request to this endpoint to remove users from a project.", "operationId":"/project/removeUsers_removeUsers_3", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user removal sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"Remove user from input.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRemoveProjectUserPermissions", "$ref":"#/components/schemas/ApiEntityRemoveProjectUserPermissions", "exampleSetFlag":false }, "examples":{ "Remove_Users_Assigned_to_a_Project":{ "summary":"Remove Users Assigned to a Project", "description":"Payload to remove users assigned to a project by using the workspace code, project code, and user name.", "value":{ "workspaceCode":"PROD", "projectCode":"PROJ1", "userNames":[ "Adams@example.com", "Baker@example.com" ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRemoveProjectUserPermissionsResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-removeUsers-post", "x-filename-id":"project-removeusers-post" } }, "/project/removeUsersFromGroup":{ "post":{ "tags":[ "Project" ], "summary":"Remove User From User Group", "description":"Use this endpoint to remove users from user group at given project.", "operationId":"/project/removeUsersFromGroup_removeUsersFromGroup", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user to group assignment/removal sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"Remove user from group input.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectUserGroupAssignmentInput", "$ref":"#/components/schemas/ApiEntityProjectUserGroupAssignmentInput", "exampleSetFlag":false }, "examples":{ "Remove_User_From_User_Group_using_Project_ID":{ "summary":"Remove User From User Group using Project ID", "description":"Payload to remove a user from a user group in a project by using the project ID, user group ID, and user name.", "value":{ "projectId":4301, "userGroupId":6301, "userNames":[ "Baker@example.com" ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityProjectUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-removeUsersFromGroup-post", "x-filename-id":"project-removeusersfromgroup-post" } }, "/project/removeUserGroups":{ "post":{ "tags":[ "Project" ], "summary":"Remove User Groups Assigned to a Project", "description":"Send a request to this endpoint to remove user groups from a project.", "operationId":"/project/removeUserGroups_removeUsersGroups", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user group removal sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"Remove user group from input.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRemoveProjectUserGroupPermissions", "$ref":"#/components/schemas/ApiEntityRemoveProjectUserGroupPermissions", "exampleSetFlag":false }, "examples":{ "Remove_User_Groups_Assigned_to_a_Project":{ "summary":"Remove User Groups Assigned to a Project", "description":"Payload to remove user groups from a project by using the workspace ID and user group IDs.", "value":{ "projectId":4301, "userGroupIds":[ "101", "102" ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRemoveProjectUserGroupPermissionsResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-removeUserGroups-post", "x-filename-id":"project-removeusergroups-post" } }, "/project/sync":{ "post":{ "tags":[ "Project" ], "summary":"Integrate a Project with an External Data Source", "description":"Send a request to this endpoint to create or update an integrated a project. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/project/sync_sync_5", "requestBody":{ "description":"The unique identifier of project data in an external source.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedProjectInput", "$ref":"#/components/schemas/ApiEntityExternallySourcedProjectInput", "exampleSetFlag":false }, "examples":{ "Integrate_a_Project_Using_Source_ID":{ "summary":"Integrate a Project Using Source ID", "description":"Payload to integrate project using source ID.", "value":{ "workspaceId":10001, "projectCode":"New Town - City Mall Development", "projectName":"New Town - City Mall Development", "sourceId":"1" }, "valueSetFlag":true } }, "exampleSetFlag":false } } }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"project-sync-post", "x-filename-id":"project-sync-post" } }, "/project/syncBatch":{ "post":{ "tags":[ "Project" ], "summary":"Batch Integrate Projects with an External Data Source", "description":"Send a request to this endpoint to create or update one or more integrated projects with an external data source.", "operationId":"/project/syncBatch_syncBatch_37", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any project sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"The unique identifier of project data in an external source.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Projects_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create or Update Projects by Assigning Code Values Using Codes", "description":"Payload to create or update projects using the project code, workspace code, project name, project ID, and codeValuesProject fields such as code value code and code type code.", "value":[ { "codeValuesProject":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ], "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "workspaceCode":"Asia" }, { "codeValuesProject":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "projectId":244756 } ], "valueSetFlag":true }, "Create_or_Update_Projects_to_Assign_a_Configured_Field":{ "summary":"Create or Update Projects to Assign a Configured Field", "description":"Payload to create or update projects using the project code, workspace code, project name, project ID, and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "configuredFields":[ { "columnLabel":"PLANNER_NOTES", "textValue":"Project should be started in this month" }, { "columnDefinationId":60145, "textValue":"Y" } ], "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "workspaceCode":"Asia" }, { "configuredFields":[ { "columnLabel":"PLANNER_NOTES", "textValue":"Project should be started in this month" }, { "columnDefinationId":60245, "numberValue":2 } ], "projectId":244756 } ], "valueSetFlag":true }, "Integrate_Projects_Using_Source_IDs":{ "summary":"Integrate Projects Using Source IDs", "description":"Payload to integrate one or more projects using source IDs.", "value":[ { "workspaceId":10001, "projectCode":"New Town - City Mall Development", "projectName":"New Town - City Mall Development", "sourceId":"1" }, { "projectId":10001, "projectCode":"Delhi High Speed Rail Corridor", "projectName":"Delhi High Speed Rail Corridor - Phase#1", "sourceId":"2" } ], "valueSetFlag":true }, "Create_or_Update_Projects_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create or Update Projects by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update projects using the project code, workspace code, project name, project ID, and codeValuesProject fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesProject":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectCode":"New Town - City Mall", "projectName":"New Town - City Mall", "workspaceCode":"Asia" }, { "codeValuesProject":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "projectId":244756 } ], "valueSetFlag":true } }, "exampleSetFlag":false } } }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"project-syncBatch-post", "x-filename-id":"project-syncbatch-post" } }, "/projectBudget/project/{projectId}/changeBudgetStatus":{ "put":{ "tags":[ "Project Budget" ], "summary":"Change a Project Budget Status", "description":"Send a request to this endpoint to update the status of a project budget that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/projectBudget/project/{projectId}/changeBudgetStatus_changeBudgetStatus_1", "parameters":[ { "name":"projectId", "in":"path", "description":"Project Id whose project budget status has to be changed.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "requestBody":{ "description":"Status Transition Object with new Status and userIds to be notified.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStatusTransition", "$ref":"#/components/schemas/ApiEntityStatusTransition", "exampleSetFlag":false }, "examples":{ "Change_a_Project_Budget_Status.":{ "summary":"Change a Project Budget Status.", "description":"Payload to update the status of a project budget using the budget status.", "value":{ "budgetStatus":"PENDING" }, "valueSetFlag":true } }, "exampleSetFlag":false } } }, "responses":{ "404":{ "description":"The requested project budget does not exist, or you do not have access to it." }, "400":{ "description":"Invalid input for the Project Budget Change service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectBudget-project-{projectId}-changeBudgetStatus-put", "x-filename-id":"projectbudget-project-projectid-changebudgetstatus-put" } }, "/projectBudget/{projectBudgetId}":{ "get":{ "tags":[ "Project Budget" ], "summary":"View a Project Budget ", "description":"This endpoint returns a project budget that meet the following requirements:
  • The object has an ID that matches the value of the {projectBudgetId} path parameter.
", "operationId":"/projectBudget/{projectBudgetId}_find_54", "parameters":[ { "name":"projectBudgetId", "in":"path", "description":"ID of the Project whose Project Budget has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectBudget", "$ref":"#/components/schemas/ApiEntityProjectBudget", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectBudget-{projectBudgetId}-get", "x-filename-id":"projectbudget-projectbudgetid-get" } }, "/projectBudget/project/{projectId}":{ "get":{ "tags":[ "Project Budget" ], "summary":"View a Project Budget by Project", "description":"This endpoint returns a project budget that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/projectBudget/project/{projectId}_findForProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project ID for which Project Budget has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project budget does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectBudget", "$ref":"#/components/schemas/ApiEntityProjectBudget", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectBudget-project-{projectId}-get", "x-filename-id":"projectbudget-project-projectid-get" } }, "/projectBudget/byParent":{ "get":{ "tags":[ "Project Budget" ], "summary":"View a Project Budget by Parent Code", "description":"Send a request to this endpoint to view project budget under parent with codes matching the code fields in query parameters.", "operationId":"/projectBudget/byParent_findForProjectbyCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project budget does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectBudget", "$ref":"#/components/schemas/ApiEntityProjectBudget", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectBudget-byParent-get", "x-filename-id":"projectbudget-byparent-get" } }, "/projectBudget/project/{projectId}/statusTransitionHistory":{ "get":{ "tags":[ "Project Budget" ], "summary":"View all Project Budget Status Transition History by Project", "description":"This endpoint returns a project budget status transition history that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/projectBudget/project/{projectId}/statusTransitionHistory_findTransitionHistoryByProjectId_4", "parameters":[ { "name":"projectId", "in":"path", "description":"Project id for which Budget Status Transition History has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested status transition history does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectBudgetStatusTransitionHistory", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectBudget-project-{projectId}-statusTransitionHistory-get", "x-filename-id":"projectbudget-project-projectid-statustransitionhistory-get" } }, "/projectBudget/project/{projectId}/transactions":{ "get":{ "tags":[ "Project Budget" ], "summary":"View Budget Transactions by Project", "description":"This endpoint returns budget transactions that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
Budget transactions capture the budget transfers and budget changes for project budgets.", "operationId":"/projectBudget/project/{projectId}/transactions_getBudgetTransactionsByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Budget Transaction does not exist, or you don't have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectBudget-project-{projectId}-transactions-get", "x-filename-id":"projectbudget-project-projectid-transactions-get" } }, "/projectBudget/{projectBudgetId}/transactions":{ "get":{ "tags":[ "Project Budget" ], "summary":"View Budget Transactions by Project Budget", "description":"This endpoint returns budget transactions that meet the following requirements:
  • The object is associated with a project budget with an ID value that matches the value of the {projectBudgetId} path parameter.
Budget transactions capture the budget transfers and budget changes for project budgets.", "operationId":"/projectBudget/{projectBudgetId}/transactions_getBudgetTransactionsByProjectBudget", "parameters":[ { "name":"projectBudgetId", "in":"path", "description":"The system-generated identifier of a project budget. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Budget Transaction does not exist, or you don't have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectBudget-{projectBudgetId}-transactions-get", "x-filename-id":"projectbudget-projectbudgetid-transactions-get" } }, "/projectCashflows/batch":{ "put":{ "tags":[ "Project Cashflows" ], "summary":"Batch Update Project Cashflows", "description":"Send a request to this endpoint to update one or more project cashflows. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/projectCashflows/batch_updateBatch_35", "requestBody":{ "description":"The project cashflows to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCashFlowInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Cashflow service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"projectCashflows-batch-put", "x-filename-id":"projectcashflows-batch-put" }, "post":{ "tags":[ "Project Cashflows" ], "summary":"Batch Create Project Cashflows", "description":"Send a request to this endpoint to create one or more project cashflows. An application object will be created for each JSON object provided in the request body.", "operationId":"/projectCashflows/batch_createBatch_37", "requestBody":{ "description":"The project cashflows to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCashFlowInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Cashflow service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCashFlow", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCashflows-batch-post", "x-filename-id":"projectcashflows-batch-post" }, "delete":{ "tags":[ "Project Cashflows" ], "summary":"Batch Delete Project Cashflows", "description":"Send a request to this endpoint to delete one or more project cashflows. Objects with ID values that match the values provided in the request body will be deleted. ", "operationId":"/projectCashflows/batch_deleteBatch_37", "requestBody":{ "description":"IDs of the project cashflows to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectCashflows-batch-delete", "x-filename-id":"projectcashflows-batch-delete" } }, "/projectCashflows/download/job/{jobId}":{ "get":{ "tags":[ "Project Cashflows" ], "summary":"Download Project Cashflows", "description":"Send a request to this endpoint to download the compressed ZIP file containing a CSV file with Project Cashflows once the Export Project Cashflows Using Project Details job has completed. Send a request to the View Job Status endpoint to monitor the Export Project Cashflows Using Project Details job status.", "operationId":"/projectCashflows/download/job/{jobId}_downloadExportedCashflowData", "parameters":[ { "name":"jobId", "in":"path", "description":"The jobId field value returned as part of the Export Project Cashflows Using Project Details endpoint response.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input for the Action service." }, "200":{ "description":"Successful operation", "content":{ "application/zip":{ "schema":{ "title":"String", "type":"string", "format":"binary", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCashflows-download-job-{jobId}-get", "x-filename-id":"projectcashflows-download-job-jobid-get" } }, "/projectCashflows/export":{ "post":{ "tags":[ "Project Cashflows" ], "summary":"Export Project Cashflows Using Project Details", "description":"Send a request to this endpoint to trigger a job to export project cashflows in a compressed ZIP file containing a CSV file. Send a request to the View Job Status endpoint to monitor the job status. After the job has completed, the ZIP file can be downloaded using the Download Project Cashflows endpoint.", "operationId":"/projectCashflows/export_exportByProjectInfo", "requestBody":{ "description":"Details of projects to be exported.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCashflowExportProjectInput", "$ref":"#/components/schemas/ApiEntityCashflowExportProjectInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project service." }, "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityJobDetail", "$ref":"#/components/schemas/ApiEntityJobDetail", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCashflows-export-post", "x-filename-id":"projectcashflows-export-post" } }, "/projectCashflows/{projectPhaseFinancialId}":{ "get":{ "tags":[ "Project Cashflows" ], "summary":"View a Project Cashflows", "description":"This endpoint returns project cashflow that meet the following requirements:
  • The object has an ID value that matches the value of the {projectPhaseFinancialId} path parameter.
", "operationId":"/projectCashflows/{projectPhaseFinancialId}_find_55", "parameters":[ { "name":"projectPhaseFinancialId", "in":"path", "description":"The system-generated identifier of a project cashflow.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project cashflow does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectCashFlow", "$ref":"#/components/schemas/ApiEntityProjectCashFlow", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCashflows-{projectPhaseFinancialId}-get", "x-filename-id":"projectcashflows-projectphasefinancialid-get" } }, "/projectCashflows/project/{projectId}":{ "get":{ "tags":[ "Project Cashflows" ], "summary":"View all Cashflows by Project", "description":"View all Cashflows by Project ", "operationId":"/projectCashflows/project/{projectId}_getCashflowsByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCashFlow", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCashflows-project-{projectId}-get", "x-filename-id":"projectcashflows-project-projectid-get" } }, "/projectCashflows/syncBatch":{ "post":{ "tags":[ "Project Cashflows" ], "summary":"Batch Sync Project Cashflows", "description":"Send a request to this endpoint to create or update one or more project cashflows.", "operationId":"/projectCashflows/syncBatch_syncBatch_38", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any cashflow sent as part of the request.
Allowed Values: [ \"true\", \"false\" ].", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"The project cashflows to be created or updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCashFlowInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Project Cashflow service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCashflows-syncBatch-post", "x-filename-id":"projectcashflows-syncbatch-post" } }, "/projectDependency":{ "put":{ "tags":[ "Project Dependency" ], "summary":"Update a Project Dependency", "description":"Send a request to this endpoint to update a project dependency. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/projectDependency_update_39", "requestBody":{ "description":"Project Dependency to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectDependencyInput", "$ref":"#/components/schemas/ApiEntityProjectDependencyInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Dependency_Using_the_Project_Dependency_ID":{ "summary":"Update a Project Dependency Using the Project Dependency ID", "description":"Payload to update the project dependency of a project using the project ID and project dependency ID.", "value":{ "projectId":1666803, "projectDependencyId":44204 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectDependency-put", "x-filename-id":"projectdependency-put" }, "post":{ "tags":[ "Project Dependency" ], "summary":"Create a Project Dependency", "description":"Send a request to this endpoint to create a project dependency. An application object will be created for each JSON object provided in the request body.", "operationId":"/projectDependency_create_41", "requestBody":{ "description":"Project Dependency to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectDependencyInput", "$ref":"#/components/schemas/ApiEntityProjectDependencyInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Dependency":{ "summary":"Create a Project Dependency", "description":"Payload to create a project dependency using the project ID and dependent project ID.", "value":{ "projectId":1664915, "dependentProjectId":1656816 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectDependency", "$ref":"#/components/schemas/ApiEntityProjectDependency", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectDependency-post", "x-filename-id":"projectdependency-post" } }, "/projectDependency/batch":{ "put":{ "tags":[ "Project Dependency" ], "summary":"Batch Update Project Dependencies", "description":"Send a request to this endpoint to update one or more project dependencies. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/projectDependency/batch_updateBatch_36", "requestBody":{ "description":"Project Dependencies to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectDependencyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Dependencies_Using_Project_Dependency_IDs":{ "summary":"Batch Update Project Dependencies Using Project Dependency IDs", "description":"Payload to update the project dependency of one or more projects using the project IDs and project dependency IDs.", "value":[ { "projectId":1666803, "projectDependencyId":44202 }, { "projectId":1664915, "projectDependencyId":44203 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"projectDependency-batch-put", "x-filename-id":"projectdependency-batch-put" }, "post":{ "tags":[ "Project Dependency" ], "summary":"Batch Create Project Dependencies", "description":"Send a request to this endpoint to create one or more project dependencies. An application object will be created for each JSON object provided in the request body.", "operationId":"/projectDependency/batch_createBatch_38", "requestBody":{ "description":"Project Dependencies to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectDependencyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Dependencies":{ "summary":"Batch Create Project Dependencies", "description":"Payload to create one or more project dependencies using the project ID and dependent project ID.", "value":[ { "projectId":1664915, "dependentProjectId":1656810 }, { "projectId":1664915, "dependentProjectId":1656812 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectDependency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectDependency-batch-post", "x-filename-id":"projectdependency-batch-post" }, "delete":{ "tags":[ "Project Dependency" ], "summary":"Batch Delete Project Dependencies", "description":"Send a request to this endpoint to delete one or more project dependencies. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/projectDependency/batch_deleteBatch_38", "requestBody":{ "description":"IDs of the Project Dependencies to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectDependency-batch-delete", "x-filename-id":"projectdependency-batch-delete" } }, "/projectDependency/{projectDependencyId}":{ "get":{ "tags":[ "Project Dependency" ], "summary":"View a Project Dependency", "description":"This endpoint returns a project dependency that meet the following requirements:
  • The object has an ID that matches the value of the {projectDependencyId} path parameter.
", "operationId":"/projectDependency/{projectDependencyId}_find_56", "parameters":[ { "name":"projectDependencyId", "in":"path", "description":"ID of the Project Dependency to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project dependency does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectDependency", "$ref":"#/components/schemas/ApiEntityProjectDependency", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectDependency-{projectDependencyId}-get", "x-filename-id":"projectdependency-projectdependencyid-get" }, "delete":{ "tags":[ "Project Dependency" ], "summary":"Delete a Project Dependency", "description":"Send a request to this endpoint to delete a project dependency. The application object with an ID value that matches the value of the {projectDependencyId} path parameter will be deleted.", "operationId":"/projectDependency/{projectDependencyId}_delete_41", "parameters":[ { "name":"projectDependencyId", "in":"path", "description":"ID of the Project Dependency to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectDependency-{projectDependencyId}-delete", "x-filename-id":"projectdependency-projectdependencyid-delete" } }, "/projectDependency/dependsOn/project/{projectId}":{ "get":{ "tags":[ "Project Dependency" ], "summary":"View all Project Dependencies that Depend on a Specific Project", "description":"This endpoint returns project dependencies dependent on a specific project that meet the following requirements:
  • The object depends on a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/projectDependency/dependsOn/project/{projectId}_findDependsOn", "parameters":[ { "name":"projectId", "in":"path", "description":"The unique identifier of a project that has other projects depending on it.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project dependency does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectDependency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectDependency-dependsOn-project-{projectId}-get", "x-filename-id":"projectdependency-dependson-project-projectid-get" } }, "/projectDependency/supports/project/{projectId}":{ "get":{ "tags":[ "Project Dependency" ], "summary":"View all Project Dependencies that Support a Specific Project", "description":"This endpoint returns project dependencies supporting a specific project that meet the following requirements:
  • The object supports a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/projectDependency/supports/project/{projectId}_findSupportsOn", "parameters":[ { "name":"projectId", "in":"path", "description":"The unique identifier of a project that has other projects that it relies on for support.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project dependency does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectDependency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectDependency-supports-project-{projectId}-get", "x-filename-id":"projectdependency-supports-project-projectid-get" } }, "/projectDependency/supportedBy":{ "get":{ "tags":[ "Project Dependency" ], "summary":"View all Project Dependencies by Parent", "description":"Send a request to this endpoint to view all project dependencies under a workspace with codes matching the code fields in query parameters.", "operationId":"/projectDependency/supportedBy_getAllProjectDependenciesByParentCode", "parameters":[ { "name":"projectWorkspaceCode", "in":"query", "description":"The workspace code of a project that has other projects depending on it.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project dependency does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectDependency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectDependency-supportedBy-get", "x-filename-id":"projectdependency-supportedby-get" } }, "/projectDependency/itemCode":{ "get":{ "tags":[ "Project Dependency" ], "summary":"View a Project Dependency by Codes", "description":"Send a request to this endpoint to view a project dependency with codes matching the code fields in query parameters.", "operationId":"/projectDependency/itemCode_getProjectDependencyByCode", "parameters":[ { "name":"projectWorkspaceCode", "in":"query", "description":"The workspace code of a project that has other projects depending on it.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The project code of a project that has other projects depending on it.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"dependentProjectWorkspaceCode", "in":"query", "description":"The workspace code of a project that has other projects that it relies on for support.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"dependentProjectCode", "in":"query", "description":"The project code of a project that has other projects that it relies on for support.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectDependency", "$ref":"#/components/schemas/ApiEntityProjectDependency", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectDependency-itemCode-get", "x-filename-id":"projectdependency-itemcode-get" } }, "/projectDependency/syncBatch":{ "post":{ "tags":[ "Project Dependency" ], "summary":"Batch Sync Project Dependencies", "description":"Send a request to this endpoint to create or update one or more project dependencies.", "operationId":"/projectDependency/syncBatch_syncBatch_39", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any project dependencies sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more Project Dependencies.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectDependencyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Project_Dependency":{ "summary":"Create or Update a Project Dependency", "description":"Payload to create or update a project dependency using the project ID and dependent project ID.", "value":[ { "projectId":1664915, "dependentProjectId":1656816 } ], "valueSetFlag":true }, "Create_or_Update_a_Project_Dependency_Using_Codes":{ "summary":"Create or Update a Project Dependency Using Codes", "description":"Payload to create or update a project dependency using the project code, dependent project code, project workspace code, and dependent project workspace code.", "value":[ { "dependentProjectCode":"New Town - City Mall", "dependentProjectWorkspaceCode":"North America", "projectCode":"New Town - Apartments", "projectWorkspaceCode":"North America" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectDependency-syncBatch-post", "x-filename-id":"projectdependency-syncbatch-post" } }, "/projectRank":{ "put":{ "tags":[ "Project Rank" ], "summary":"Update a Project Rank", "description":"Send a request to this endpoint to update a project rank. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/projectRank_update_40", "requestBody":{ "description":"Project Rank value to be updated ", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectRankInput", "$ref":"#/components/schemas/ApiEntityProjectRankInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Rank_Using_Project_Rank_ID":{ "summary":"Update a Project Rank Using Project Rank ID", "description":"Payload to update the evaluation rank ID of a project rank using the project rank ID.", "value":{ "evaluationRankId":172414, "projectRankId":918611 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectRank-put", "x-filename-id":"projectrank-put" }, "post":{ "tags":[ "Project Rank" ], "summary":"Create a Project Rank", "description":"Send a request to this endpoint to create a project rank. An application object will be created using the JSON data provided in the request body.", "operationId":"/projectRank_create_42", "requestBody":{ "description":"Project Rank Value to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectRankInput", "$ref":"#/components/schemas/ApiEntityProjectRankInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Rank":{ "summary":"Create a Project Rank", "description":"Payload to create a project rank using the project ID, evaluation rank ID, evaluation category ID, and evaluation Subcategory ID.", "value":{ "projectId":1656816, "evaluationRankId":172413, "evaluationCategoryId":74201, "evaluationSubCategoryId":166303 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectRank", "$ref":"#/components/schemas/ApiEntityProjectRank", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRank-post", "x-filename-id":"projectrank-post" } }, "/projectRank/batch":{ "put":{ "tags":[ "Project Rank" ], "summary":"Batch Update Project Ranks", "description":"Send a request to this endpoint to update one or more project ranks. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/projectRank/batch_updateBatch_37", "requestBody":{ "description":"Project Rank Values to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRankInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Ranks_Using_Project_Rank_IDs":{ "summary":"Batch Update Project Ranks Using Project Rank IDs", "description":"Payload to update the evaluation rank ID of one or more project ranks using the project rank IDs.", "value":[ { "evaluationRankId":172413, "projectRankId":918612 }, { "evaluationRankId":78304, "projectRankId":918613 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"projectRank-batch-put", "x-filename-id":"projectrank-batch-put" }, "post":{ "tags":[ "Project Rank" ], "summary":"Batch Create Project Ranks", "description":"Send a request to this endpoint to create one or more project ranks. An application object will be created for each JSON object provided in the request body. ", "operationId":"/projectRank/batch_createBatch_39", "requestBody":{ "description":"Project Rank Values to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRankInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Ranks":{ "summary":"Batch Create Project Ranks", "description":"Payload to create one or more project ranks using the project IDs, evaluation rank IDs, evaluation category IDs, and evaluation Subcategory IDs.", "value":[ { "projectId":1656816, "evaluationRankId":172413, "evaluationCategoryId":74201, "evaluationSubCategoryId":166303 }, { "projectId":1656816, "evaluationRankId":78304, "evaluationCategoryId":74201, "evaluationSubCategoryId":76201 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRank", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRank-batch-post", "x-filename-id":"projectrank-batch-post" } }, "/projectRank/{projectRankId}":{ "get":{ "tags":[ "Project Rank" ], "summary":"View a Project Rank", "description":"This endpoint returns a project rank that meet the following requirements:
  • The object has an ID that matches the value of the {projectRankId} path parameter.
", "operationId":"/projectRank/{projectRankId}_find_57", "parameters":[ { "name":"projectRankId", "in":"path", "description":"ID of the Project Rank that has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project rank does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectRank", "$ref":"#/components/schemas/ApiEntityProjectRank", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRank-{projectRankId}-get", "x-filename-id":"projectrank-projectrankid-get" } }, "/projectRank/project/{projectId}":{ "get":{ "tags":[ "Project Rank" ], "summary":"View all Project Ranks by Project", "description":"This endpoint returns a project rank that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/projectRank/project/{projectId}_findByProjectId_4", "parameters":[ { "name":"projectId", "in":"path", "description":"ID of the Project for which Project Rank has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project rank does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRank", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRank-project-{projectId}-get", "x-filename-id":"projectrank-project-projectid-get" } }, "/projectRank/syncBatch":{ "post":{ "tags":[ "Project Rank" ], "summary":"Batch Sync Project Ranks", "description":"Send a request to this endpoint to create or update one or more project ranks.", "operationId":"/projectRank/syncBatch_syncBatch_40", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any project ranks sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more Project Ranks.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRankInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Project_Rank":{ "summary":"Create or Update a Project Rank", "description":"Payload to create or update a project rank using the project ID, evaluation rank ID, evaluation category ID, and evaluation subcategory ID.", "value":[ { "projectId":1656816, "evaluationRankId":172413, "evaluationCategoryId":74201, "evaluationSubCategoryId":166303 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRank-syncBatch-post", "x-filename-id":"projectrank-syncbatch-post" } }, "/projectResourceWorkRate":{ "put":{ "tags":[ "Project Resource Work Rate" ], "summary":"Update a Project Resource Work Rate", "description":"Send a request to this endpoint to update a project resource work rate.", "operationId":"/projectResourceWorkRate_update_41", "requestBody":{ "description":"A project resource work rate object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectResourceWorkRateInput", "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Resource_Work_Rate_Using_Resource_Work_Rate_ID":{ "summary":"Update a Project Resource Work Rate Using Resource Work Rate ID", "description":"Payload to update a max units per time of project resource work rate using the project resource work rate ID.", "value":{ "projectResourceWorkRateId":68101, "maxUnitsPerTime":0.5 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectResourceWorkRate-put", "x-filename-id":"projectresourceworkrate-put" }, "post":{ "tags":[ "Project Resource Work Rate" ], "summary":"Create a Project Resource Work Rate", "description":"Send a request to this endpoint to create a project resource work rate.", "operationId":"/projectResourceWorkRate_create_43", "requestBody":{ "description":"A project resource work rate object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectResourceWorkRateInput", "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Resource_Work_Rate":{ "summary":"Create a Project Resource Work Rate", "description":"Payload to create a project resource work rate using the project ID, max units per time, effective start date, and resource ID.", "value":{ "projectId":222101, "maxUnitsPerTime":1, "effectiveStartDate":"2023-04-23T00:00:00", "resourceId":324101 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectResourceWorkRate", "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRate", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectResourceWorkRate-post", "x-filename-id":"projectresourceworkrate-post" } }, "/projectResourceWorkRate/batch":{ "put":{ "tags":[ "Project Resource Work Rate" ], "summary":"Batch Update Project Resource Work Rates", "description":"Send a request to this endpoint to update one or more project resource work rates.", "operationId":"/projectResourceWorkRate/batch_updateBatch_38", "requestBody":{ "description":"One or more project resource work rate objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Resource_Work_Rates_Using_Resource_Work_Rate_IDs":{ "summary":"Batch Create Project Resource Work Rates Using Resource Work Rate IDs", "description":"Payload to update a max units per time of one or more project resource work rates using the project resource work rate IDs.", "value":[ { "projectResourceWorkRateId":68102, "maxUnitsPerTime":0.5 }, { "projectResourceWorkRateId":68103, "maxUnitsPerTime":0.5 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"projectResourceWorkRate-batch-put", "x-filename-id":"projectresourceworkrate-batch-put" }, "post":{ "tags":[ "Project Resource Work Rate" ], "summary":"Batch Create Project Resource Work Rates", "description":"Send a request to this endpoint to create one or more project resource work rates.", "operationId":"/projectResourceWorkRate/batch_createBatch_40", "requestBody":{ "description":"One or more project resource work rate objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Resource_Work_Rates":{ "summary":"Batch Create Project Resource Work Rates", "description":"Payload to create one or more project resource work rates using project IDs, max units per time, effective start dates, and resource IDs.", "value":[ { "projectId":222101, "maxUnitsPerTime":1, "effectiveStartDate":"2023-05-23T00:00:00", "resourceId":324101 }, { "projectId":222101, "maxUnitsPerTime":1, "effectiveStartDate":"2023-06-23T00:00:00", "resourceId":324101 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectResourceWorkRate-batch-post", "x-filename-id":"projectresourceworkrate-batch-post" } }, "/projectResourceWorkRate/{projectResourceWorkRateId}":{ "get":{ "tags":[ "Project Resource Work Rate" ], "summary":"View a Project Resource Work Rate", "description":"This endpoint returns a project resource work rate that meet the following requirements:
  • The object has an ID that matches the value of the {projectResourceWorkRateId} path parameter.
", "operationId":"/projectResourceWorkRate/{projectResourceWorkRateId}_find_58", "parameters":[ { "name":"projectResourceWorkRateId", "in":"path", "description":"The system-generated identifier of a project resource work rate.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project resource work rate does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectResourceWorkRate", "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRate", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectResourceWorkRate-{projectResourceWorkRateId}-get", "x-filename-id":"projectresourceworkrate-projectresourceworkrateid-get" } }, "/projectResourceWorkRate/parentCode":{ "get":{ "tags":[ "Project Resource Work Rate" ], "summary":"View All Project Resource Work Rates by Parent", "description":"Send a request to this endpoint to view all project resource work rates under parent with codes matching the code fields in query parameters.", "operationId":"/projectResourceWorkRate/parentCode_findAllProjectResourceWorkRatesByParent", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"resourceCode", "in":"query", "description":"The user-specified identifier of a resource.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project resource work rate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectResourceWorkRate-parentCode-get", "x-filename-id":"projectresourceworkrate-parentcode-get" } }, "/projectResourceWorkRate/project/{projectId}/resource/{resourceId}":{ "get":{ "tags":[ "Project Resource Work Rate" ], "summary":"View all Project Resource Work Rates by Project and Resource", "description":"This endpoint returns a project resource work rate that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a resource with an ID value that matches the value of the {resourceId} path parameter.
", "operationId":"/projectResourceWorkRate/project/{projectId}/resource/{resourceId}_findByProjectAndResource", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project resource work rate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectResourceWorkRate-project-{projectId}-resource-{resourceId}-get", "x-filename-id":"projectresourceworkrate-project-projectid-resource-resourceid-get" } }, "/projectResourceWorkRate/workspace/{workspaceCode}/project/{projectCode}":{ "get":{ "tags":[ "Project Resource Work Rate" ], "summary":"View Project Resource Work Rates by Project and Workspace Code", "description":"Send a request to this endpoint to view the work rates of all resources belonging to a project with code values that match the values of the path parameters.", "operationId":"/projectResourceWorkRate/workspace/{workspaceCode}/project/{projectCode}_findByprojectCode", "parameters":[ { "name":"projectCode", "in":"path", "description":"The user-specified identifier of a project.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project resource work rate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectResourceWorkRate-workspace-{workspaceCode}-project-{projectCode}-get", "x-filename-id":"projectresourceworkrate-workspace-workspacecode-project-projectcode-get" } }, "/projectResourceWorkRate/project/{projectId}":{ "get":{ "tags":[ "Project Resource Work Rate" ], "summary":"View Project Resource Work Rates by Project", "description":"Send a request to this endpoint to view the project resource work rates of all resources belonging to a project with an ID value that matches the value of the {projectId} path parameter.", "operationId":"/projectResourceWorkRate/project/{projectId}_findByprojectId", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project resource work rate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectResourceWorkRate-project-{projectId}-get", "x-filename-id":"projectresourceworkrate-project-projectid-get" } }, "/projectResourceWorkRate/projectResource/{projectResourceId}":{ "get":{ "tags":[ "Project Resource Work Rate" ], "summary":"View all Project Resource Work Rates by Project Resource ", "description":"This endpoint returns a project resource work rate that meet the following requirements:
  • The object has a project resource with an ID value that matches the value of the {projectResourceId} path parameter.
", "operationId":"/projectResourceWorkRate/projectResource/{projectResourceId}_findByprojectResourceId", "parameters":[ { "name":"projectResourceId", "in":"path", "description":"The system-generated identifier of a project resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project resource work rate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectResourceWorkRate-projectResource-{projectResourceId}-get", "x-filename-id":"projectresourceworkrate-projectresource-projectresourceid-get" } }, "/projectResourceWorkRate/syncBatch":{ "post":{ "tags":[ "Project Resource Work Rate" ], "summary":"Batch Sync Project Resource Work Rates", "description":"Send a request to this endpoint to create or update one or more project resource work rates.", "operationId":"/projectResourceWorkRate/syncBatch_syncBatch_41", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any project resource work rate sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more project resource work rates.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Project_Resource_Work_Rate":{ "summary":"Create or Update a Project Resource Work Rate", "description":"Payload to create or update a project resource work rate using the project ID, max units per time, effective start date, and resource ID.", "value":[ { "projectId":222101, "maxUnitsPerTime":1, "effectiveStartDate":"2023-04-23T00:00:00", "resourceId":324101 } ], "valueSetFlag":true }, "Create_or_Update_a_Project_Resource_Work_Rate_Using_Price_Per_Unit":{ "summary":"Create or Update a Project Resource Work Rate Using Price Per Unit", "description":"Payload to create or update a project resource work rate using the project ID, max units per time, price per unit, effective start date, and resource ID.", "value":[ { "projectId":222101, "maxUnitsPerTime":1, "effectiveStartDate":"2023-04-23T00:00:00", "resourceId":324101, "resourceWorkRateCost":{ "pricePerUnit2":20, "pricePerUnit1":10 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectResourceWorkRate-syncBatch-post", "x-filename-id":"projectresourceworkrate-syncbatch-post" } }, "/projectRisk":{ "put":{ "tags":[ "Project Risk" ], "summary":"Update a Project Risk", "description":"Send a request to this endpoint to update a project risk.", "operationId":"/projectRisk_update_42", "requestBody":{ "description":"A project risk object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectRiskInput", "$ref":"#/components/schemas/ApiEntityProjectRiskInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Risk_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Project Risk by Assigning Code Values Using IDs", "description":"Payload to update the project risk using the project risk ID and codeValuesRisk fields such as code value ID and code type ID.", "value":{ "projectRiskId":72101, "codeValuesRisk":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Project_Risk_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Project Risk by Assigning Code Values Using Codes", "description":"Payload to update the project risk using the project risk ID and codeValuesRisk fields such as code value code and code type code", "value":{ "projectRiskId":72101, "codeValuesRisk":[ { "codeTypeCode":"RISK_PESTLE_CODE", "codeValueCode":"POL" } ] }, "valueSetFlag":true }, "Update_a_Project_Risk_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Project Risk by Assigning Multiple Code Values Using IDs", "description":"Payload to update the project risk using the project risk ID and codeValuesRisk fields such as code value ID and code type ID.", "value":{ "projectRiskId":72101, "codeValuesRisk":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":25, "codeValueId":941041 } ] }, "valueSetFlag":true }, "Update_a_Project_Risk_Using_Project_Risk_ID":{ "summary":"Update a Project Risk Using Project Risk ID", "description":"Payload to update the owner and project risk status using the project risk ID.", "value":{ "projectRiskId":72101, "ownerId":10001, "projectRiskStatus":"OPEN" }, "valueSetFlag":true }, "Update_a_Project_Risk_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Project Risk by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the project risk using the project risk ID and codeValuesRisk fields such as code value code, code type code and parent ID of parent code value.", "value":{ "projectRiskId":72101, "codeValuesRisk":[ { "parentId":298203, "codeTypeCode":"RISK_PESTLE_CODE", "codeValueCode":"POL" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectRisk-put", "x-filename-id":"projectrisk-put" }, "post":{ "tags":[ "Project Risk" ], "summary":"Create a Project Risk", "description":"Send a request to this endpoint to create a project risk.", "operationId":"/projectRisk_create_44", "requestBody":{ "description":"A project risk object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectRiskInput", "$ref":"#/components/schemas/ApiEntityProjectRiskInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Riskb_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Project Risk by Assigning Multiple Code Values Using IDs", "description":"Payload to create a project risk using the project ID, project risk code, name, description, cause, effect, type, status, impacts, and codeValuesRisk fields such as code value ID and code type ID.", "value":{ "projectId":84101, "riskCode":"R01", "riskName":"Marsh condition near the main field of construction site", "cause":"The slope of the land and runoff from other areas causes marsh conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "projectRiskStatus":"IMPACTING", "impacts":[ { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Schedule Threshold" }, { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Cost Threshold" }, { "riskScoreThresholdCode":"VL", "riskScoreTypeName":"Probability" } ], "codeValuesRisk":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Project_Risk":{ "summary":"Create a Project Risk", "description":"Payload to create a project risk using the project ID, project risk code, name, description, cause, effect, type, status, and impacts.", "value":{ "projectId":84101, "riskCode":"R01", "riskName":"Marsh condition near the main field of construction site", "cause":"The slope of the land and runoff from other areas causes marsh conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "projectRiskStatus":"IMPACTING", "impacts":[ { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Schedule Threshold" }, { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Cost Threshold" }, { "riskScoreThresholdCode":"VL", "riskScoreTypeName":"Probability" } ] }, "valueSetFlag":true }, "Create_a_Project_Risk_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Project Risk by Assigning Code Values Using Codes", "description":"Payload to create a project risk using the project ID, project risk code, name, description, cause, effect, type, status, impacts, and codeValuesRisk fields such as code value code and code type code.", "value":{ "projectId":84101, "riskCode":"R01", "riskName":"Marsh condition near the main field of construction site", "cause":"The slope of the land and runoff from other areas causes marsh conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "projectRiskStatus":"IMPACTING", "impacts":[ { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Schedule Threshold" }, { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Cost Threshold" }, { "riskScoreThresholdCode":"VL", "riskScoreTypeName":"Probability" } ], "codeValuesRisk":[ { "codeTypeCode":"RISK_PESTLE_CODE", "codeValueCode":"POL" } ] }, "valueSetFlag":true }, "Create_a_Project_Risk_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Project Risk by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a project risk using the project ID, project risk code, name, description, cause, effect, type, status, impacts, and codeValuesRisk fields such as code value code, code type code, and parent ID of parent code value.", "value":{ "projectId":84101, "riskCode":"R01", "riskName":"Marsh condition near the main field of construction site", "cause":"The slope of the land and runoff from other areas causes marsh conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "projectRiskStatus":"IMPACTING", "impacts":[ { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Schedule Threshold" }, { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Cost Threshold" }, { "riskScoreThresholdCode":"VL", "riskScoreTypeName":"Probability" } ], "codeValuesRisk":[ { "parentId":298203, "codeTypeCode":"RISK_PESTLE_CODE", "codeValueCode":"POL-L" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectRisk", "$ref":"#/components/schemas/ApiEntityProjectRisk", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-post", "x-filename-id":"projectrisk-post" } }, "/projectRisk/batch":{ "put":{ "tags":[ "Project Risk" ], "summary":"Batch Update Project Risks", "description":"Send a request to this endpoint to update one or more project risks.", "operationId":"/projectRisk/batch_updateBatch_39", "requestBody":{ "description":"A project risk object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Risks_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Project Risks by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the project risk using the project risk IDs and codeValuesRisk fields such as code value code, code type code, and parent ID of parent code value.", "value":[ { "projectRiskId":72101, "codeValuesRisk":[ { "parentId":298203, "codeTypeCode":"RBS", "codeValueCode":"1.2" } ] }, { "projectRiskId":72102, "codeValuesRisk":[ { "parentId":298203, "codeTypeCode":"RBS", "codeValueCode":"1.1" } ] } ], "valueSetFlag":true }, "Batch_Update_Project_Risks_Using_Project_Risk_IDs":{ "summary":"Batch Update Project Risks Using Project Risk IDs", "description":"Payload to update the owners and project risk statuses of one or more project risks using the project risk IDs.", "value":[ { "projectRiskId":72101, "ownerId":10001, "projectRiskStatus":"OPEN" }, { "projectRiskId":72102, "ownerId":10001, "projectRiskStatus":"REJECTED" } ], "valueSetFlag":true }, "Batch_Update_Project_Risks_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Project Risks by Assigning Code Values Using Codes or IDs", "description":"Payload to update the project risk using the project risk IDs and codeValuesRisk fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "projectRiskId":72101, "codeValuesRisk":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, { "projectRiskId":72102, "codeValuesRisk":[ { "codeTypeCode":"RISK_PESTLE_CODE", "codeValueCode":"POL" }, { "codeTypeCode":"RBS", "codeValueCode":"1" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"projectRisk-batch-put", "x-filename-id":"projectrisk-batch-put" }, "post":{ "tags":[ "Project Risk" ], "summary":"Batch Create Project Risks", "description":"Send a request to this endpoint to create one or more project risks.", "operationId":"/projectRisk/batch_createBatch_41", "requestBody":{ "description":"A project risk object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Risks_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Project Risks by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create one or more project risks using the project IDs, project risk codes, names, causes, descriptions, effects, types, statuses and codeValuesRisks fields such as code value code, code type code, and parent ID of parent code value.", "value":[ { "projectId":84101, "riskCode":"R01", "riskName":"Marsh condition near the main field of construction site", "cause":"The slope of the land and runoff from other areas causes march conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "projectRiskStatus":"IMPACTING", "codeValuesRisk":[ { "parentId":298203, "codeTypeCode":"RBS", "codeValueCode":"1.1" } ] }, { "projectId":84101, "riskCode":"R02", "riskName":"Labor shortages", "cause":"There might be social, political, and economic disturbances that cause the shortage of labor", "description":"Availability of labor for work", "effect":"May demand to hire inexperienced labors which lead to decrease in productivity", "riskType":"THREAT", "projectRiskStatus":"MONITORING", "codeValuesRisk":[ { "parentId":298203, "codeTypeCode":"RBS", "codeValueCode":"1.2" } ] } ], "valueSetFlag":true }, "Batch_Create_Project_Risks":{ "summary":"Batch Create Project Risks", "description":"Payload to create one or more project risks using the project IDs, project risk codes, names, causes, descriptions, effects, types, and statuses.", "value":[ { "projectId":84101, "riskCode":"R01", "riskName":"Marsh condition near the main field of construction site", "cause":"The slope of the land and runoff from other areas causes march conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "projectRiskStatus":"IMPACTING" }, { "projectId":84101, "riskCode":"R02", "riskName":"Labor shortages", "cause":"There might be social, political, and economic disturbances that cause the shortage of labor", "description":"Availability of labor for work", "effect":"May demand to hire inexperienced labors which lead to decrease in productivity", "riskType":"THREAT", "projectRiskStatus":"MONITORING" } ], "valueSetFlag":true }, "Batch_Create_Project_Risks_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Project Risks by Assigning Code Values Using Codes", "description":"Payload to create one or more project risks using the project IDs, project risk codes, names, causes, descriptions, effects, types, statuses and codeValuesRisks fields such as code value code and code type code.", "value":[ { "projectId":84101, "riskCode":"R01", "riskName":"Marsh condition near the main field of construction site", "cause":"The slope of the land and runoff from other areas causes march conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "projectRiskStatus":"IMPACTING", "codeValuesRisk":[ { "codeTypeCode":"RISK_PESTLE_CODE", "codeValueCode":"POL" }, { "codeTypeCode":"RBS", "codeValueCode":"1" } ] }, { "projectId":84101, "riskCode":"R02", "riskName":"Labor shortages", "cause":"There might be social, political, and economic disturbances that cause the shortage of labor", "description":"Availability of labor for work", "effect":"May demand to hire inexperienced labors which lead to decrease in productivity", "riskType":"THREAT", "projectRiskStatus":"MONITORING", "codeValuesRisk":[ { "codeTypeCode":"RISK_PESTLE_CODE", "codeValueCode":"ECO" }, { "codeTypeCode":"RBS", "codeValueCode":"2" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-batch-post", "x-filename-id":"projectrisk-batch-post" }, "delete":{ "tags":[ "Project Risk" ], "summary":"Batch Delete Project Risks", "description":"Send a request to this endpoint to delete one or more project risks.", "operationId":"/projectRisk/batch_deleteBatch_39", "requestBody":{ "description":"IDs of the project risks to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectRisk-batch-delete", "x-filename-id":"projectrisk-batch-delete" } }, "/projectRisk/{projectRiskId}":{ "get":{ "tags":[ "Project Risk" ], "summary":"View a Project Risk", "description":"This endpoint returns project risks that meet the following requirements:
  • The object has an ID that matches the value of the {projectRiskId} path parameter.
", "operationId":"/projectRisk/{projectRiskId}_find_59", "parameters":[ { "name":"projectRiskId", "in":"path", "description":"The system-generated identifier of a project risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectRisk", "$ref":"#/components/schemas/ApiEntityProjectRisk", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-{projectRiskId}-get", "x-filename-id":"projectrisk-projectriskid-get" }, "delete":{ "tags":[ "Project Risk" ], "summary":"Delete a Project Risk", "description":"Send a request to this endpoint to delete a project risk. The application object with an ID value that matches the value of the {projectRiskId} path parameter will be deleted.", "operationId":"/projectRisk/{projectRiskId}_delete_42", "parameters":[ { "name":"projectRiskId", "in":"path", "description":"The system-generated identifier of a project risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectRisk-{projectRiskId}-delete", "x-filename-id":"projectrisk-projectriskid-delete" } }, "/projectRisk/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Project Risk" ], "summary":"View all Project Risks by Assigned CodeValue", "description":"This endpoint returns project risks that meet the following requirements:
  • The object is assigned a code type that matches the value of the {codeTypeId} path parameter with a value that matches the value of the {codeValueCode} path parameter.
", "operationId":"/projectRisk/codeType/{codeTypeId}/codeValue/{codeValueCode}_findByCodeValue_3", "parameters":[ { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"projectrisk-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/projectRisk/name/{riskName}":{ "get":{ "tags":[ "Project Risk" ], "summary":"View all Project Risks by Name", "description":"Send a request to this endpoint to view a project risk with a name value matching the value of the {riskName} path parameter.", "operationId":"/projectRisk/name/{riskName}_findByName_10", "parameters":[ { "name":"riskName", "in":"path", "description":"The user-specified name of a project risk.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-name-{riskName}-get", "x-filename-id":"projectrisk-name-riskname-get" } }, "/projectRisk/project/{projectId}/riskCode/{riskCode}":{ "get":{ "tags":[ "Project Risk" ], "summary":"View a Project Risk by Project and Risk Code", "description":"This endpoint returns project risks that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a risk with a code value that matches the value of the {riskCode} path parameter.
", "operationId":"/projectRisk/project/{projectId}/riskCode/{riskCode}_findByProjectIdAndRiskCode", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"riskCode", "in":"path", "description":"The user-specified identifier of a risk.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectRisk", "$ref":"#/components/schemas/ApiEntityProjectRisk", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-project-{projectId}-riskCode-{riskCode}-get", "x-filename-id":"projectrisk-project-projectid-riskcode-riskcode-get" } }, "/projectRisk/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Project Risk" ], "summary":"View all Project Risks by Configured Field Value", "description":"This endpoint returns project risks that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
  • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
", "operationId":"/projectRisk/project/{projectId}/configuredField/{viewColumnName}/{value}_findByUDFValue_5", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The view column name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"projectrisk-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/projectRisk/mitigation/{projectRiskId}":{ "get":{ "tags":[ "Project Risk" ], "summary":"View Project Risk Mitigation by Project Risk ", "description":"This endpoint returns project risk mitigations that meet the following requirements:
  • The object is associated with a project risk with an ID value that matches the value of the {projectRiskId} path parameter.
", "operationId":"/projectRisk/mitigation/{projectRiskId}_findRiskMitigationsByProjectRiskId", "parameters":[ { "name":"projectRiskId", "in":"path", "description":"The system-generated identifier of a project risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMitigation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-mitigation-{projectRiskId}-get", "x-filename-id":"projectrisk-mitigation-projectriskid-get" } }, "/projectRisk/weatherPeriod/{projectRiskId}":{ "get":{ "tags":[ "Project Risk" ], "summary":"View Project Risk Weather Periods by Project Risk ", "description":"This endpoint returns project risk weather periods that meet the following requirements:
  • The object is associated with a project risk with an ID value that matches the value of the {projectRiskId} path parameter.
", "operationId":"/projectRisk/weatherPeriod/{projectRiskId}_findRiskWeatherPeriodByProjectRiskId", "parameters":[ { "name":"projectRiskId", "in":"path", "description":"The system-generated identifier of a project risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-weatherPeriod-{projectRiskId}-get", "x-filename-id":"projectrisk-weatherperiod-projectriskid-get" } }, "/projectRisk/workspace/{workspaceId}":{ "get":{ "tags":[ "Project Risk" ], "summary":"View all Project Risks in a Workspace", "description":"This endpoint returns project risks that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/projectRisk/workspace/{workspaceId}_getProgramRisksByWorkspace_1", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-workspace-{workspaceId}-get", "x-filename-id":"projectrisk-workspace-workspaceid-get" } }, "/projectRisk/projectId/{projectId}":{ "get":{ "tags":[ "Project Risk" ], "summary":"View all Project Risks by Project", "description":"This endpoint returns project risks that meet the following requirements:
  • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/projectRisk/projectId/{projectId}_getProjectRisksByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-projectId-{projectId}-get", "x-filename-id":"projectrisk-projectid-projectid-get" } }, "/projectRisk/syncBatch":{ "post":{ "tags":[ "Project Risk" ], "summary":"Batch Sync Project Risks", "description":"Send a request to this endpoint to create or update one or more project risks.", "operationId":"/projectRisk/syncBatch_syncBatch_42", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any project risk sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"A project risk object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Project_Risks_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create or Update Project Risks by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update one or more project risks using the project risk ID,workspace code, project code, risk code and name, cause, description, effect, risk type, risk status, cost category ID, and codeValuesRisk fields such as code value code, code type code, and parent ID of the parent.", "value":[ { "workspaceCode":"North America", "projectCode":"New Town - City Mall", "riskCode":"R1", "riskName":"R1", "cause":"The slope of the land and runoff from other areas causes marsh conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "projectRiskStatus":"IMPACTING", "costCategoryId":40001, "codeValuesRisk":[ { "parentId":56970, "codeTypeCode":"RBS", "codeValueCode":"1.2" } ] }, { "projectRiskId":72102, "codeValuesRisk":[ { "parentId":56971, "codeTypeCode":"RBS", "codeValueCode":"1.1" } ] } ], "valueSetFlag":true }, "Batch_Create_or_Update_Project_Risks_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create or Update Project Risks by Assigning Code Values Using Codes", "description":"Payload to create or update one or more project risks using the project risk ID,workspace code, project code, risk code and name, cause, description, effect, risk type, risk status, cost category ID, and codeValuesRisk fields such as code value code and code type code.", "value":[ { "workspaceCode":"North America", "projectCode":"New Town - City Mall", "riskCode":"R1", "riskName":"R1", "cause":"The slope of the land and runoff from other areas causes marsh conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "projectRiskStatus":"IMPACTING", "costCategoryId":40001, "codeValuesRisk":[ { "codeTypeCode":"RBS", "codeValueCode":"1.2" } ] }, { "projectRiskId":72102, "codeValuesRisk":[ { "codeTypeCode":"RBS", "codeValueCode":"1.1" } ] } ], "valueSetFlag":true }, "Batch_Create_or_Update_Project_Risks_Using_CBS_Codes_and_Cost_Category":{ "summary":"Batch Create or Update Project Risks Using CBS Codes and Cost Category", "description":"Payload to create or update one or more project risks using the workspace code, project code, risk code and name, cause, description, effect, risk type, CBS codes, risk status, and cost category ID.", "value":[ { "workspaceCode":"North America", "projectCode":"New Town - City Mall", "riskCode":"R1", "riskName":"R1", "cause":"The slope of the land and runoff from other areas causes marsh conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "cbsCodes":[ "CBS1", "CBS2" ], "projectRiskStatus":"IMPACTING", "costCategoryId":40001 } ], "valueSetFlag":true }, "Batch_Create_or_Update_Project_Risks_Using_Impacts":{ "summary":"Batch Create or Update Project Risks Using Impacts", "description":"Payload to create or update one or more project risks using the project ID, risk code and name, cause, description, effect, type of risk, address, risk status, actual schedule impact, location of the risk, risk identified by the user, date identified, and project risks financial fields such as actual cost impact, contingency, and planned response cost, impacts such as risk score type name, post and pre risk score threshold codes.", "value":[ { "projectId":40101, "riskCode":"R101", "riskName":"Marsh condition near the main field of construction site", "cause":"The slope of the land and runoff from other areas causes marsh conditions near the main field", "description":"When it rains heavily there is a swampy area that forms near the construction site", "effect":"Muddy and unworkable conditions near the work site", "riskType":"THREAT", "addressLine1":"Address1", "addressLine2":"Address2", "city":"Bangalore", "state":"Karnataka", "country":"IND", "projectRiskStatus":"IMPACTING", "actualScheduleImpact":24.8, "latitude":78.09, "longitude":90.1, "postalCode":"560057", "locationName":"Bangalore", "identifiedDate":"2023-09-07T00:00:00.+0000", "identifiedById":12001, "projectRiskFinancial":{ "actualCostImpact":100, "contingency":7000, "plannedResponseCost":200 }, "impacts":[ { "riskScoreThresholdCode":"VL", "riskScoreTypeName":"Probability", "postRiskScoreThresholdCode":"L" }, { "riskScoreThresholdCode":"M", "riskScoreTypeName":"Small Projects Schedule Threshold", "postRiskScoreThresholdCode":"H" }, { "riskScoreThresholdCode":"H", "riskScoreTypeName":"Small Projects Cost Threshold", "postRiskScoreThresholdCode":"H" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectRisk-syncBatch-post", "x-filename-id":"projectrisk-syncbatch-post" } }, "/projectsAggregate/rollupId/{rollupId}":{ "get":{ "tags":[ "Projects Aggregate" ], "summary":"View a Project Aggregate by Rollup", "description":"This endpoint returns project aggregates that meet the following requirements:
  • The object has a rollup with an ID value that matches the value of the {rollupId} path parameter.
", "operationId":"/projectsAggregate/rollupId/{rollupId}_find_60", "parameters":[ { "name":"rollupId", "in":"path", "description":"Rollup ID of the projects aggregate for which projects aggregate has to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested projects aggregate does not exist, or you do have access to it. " }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectsAggregate", "$ref":"#/components/schemas/ApiEntityProjectsAggregate", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectsAggregate-rollupId-{rollupId}-get", "x-filename-id":"projectsaggregate-rollupid-rollupid-get" } }, "/projectsAggregate/reference/{referenceObjectId}/rollupType/{rollupType}":{ "get":{ "tags":[ "Projects Aggregate" ], "summary":"View a Project Aggregate by Reference ID and Rollup Type", "description":"This endpoint returns project aggregates that meet the following requirements:
  • The object has a reference to another object with an ID value that matches the value of the {referenceObjectId} path parameter.
  • The object has a rollup with an ID value that matches the value of the {rollupId} path parameter.
", "operationId":"/projectsAggregate/reference/{referenceObjectId}/rollupType/{rollupType}_findByRefIdAndRollupType", "parameters":[ { "name":"referenceObjectId", "in":"path", "description":"Reference ID and rollup type for the projects aggregates to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"rollupType", "in":"path", "description":"The rollup type of a project aggregate.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT_2_CAPITAL_PLAN", "PROJECT_PORTFOLIO" ] } } ], "responses":{ "404":{ "description":"The requested projects aggregate does not exist, or you do have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectsAggregate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectsAggregate-reference-{referenceObjectId}-rollupType-{rollupType}-get", "x-filename-id":"projectsaggregate-reference-referenceobjectid-rolluptype-rolluptype-get" } }, "/projectsAggregate/capitalPlan":{ "post":{ "tags":[ "Projects Aggregate" ], "summary":"View a Project Aggregate by Budget Plan", "description":"This endpoint returns a project aggregate that meet the following requirements:
  • The object is associated with a budget plan with an ID value that matches one or more values of the {id} query parameter.
", "operationId":"/projectsAggregate/capitalPlan_loadByCapitalPlanIds", "requestBody":{ "description":"Unique identifiers of one or more budget plans.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "404":{ "description":"The requested projects aggregate does not exist, or you do have access to it. " }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectsAggregate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectsAggregate-capitalPlan-post", "x-filename-id":"projectsaggregate-capitalplan-post" } }, "/resource/assign/batch":{ "post":{ "tags":[ "Resource" ], "summary":"Assign Resources to Projects", "description":"Send a request to this endpoint assign multiple workspace resource to various projects.
The request body should contain a map where keys are system-generated identifiers of projects and values are lists of system-generated identifiers of resources or roles to be assigned.
Example: {\"projectId1\":[resourceId1,resourceId2],\"projectId2\":[resourceId3,resourceId4]}", "operationId":"/resource/assign/batch_assignBatchResourcesToProject", "requestBody":{ "description":"Map of system-generated identifier of a project and list of system-generated identifiers of resources.
Example: {\"projId1\":[ResId1,ResId2],\"projId2\":[ResId3,ResId4]}
", "content":{ "application/json":{ "schema":{ "title":"String", "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "examples":{ "Assign_Resources_to_Projects":{ "summary":"Assign Resources to Projects", "description":"Payload to assign resources to specific projects.", "value":{ "1":[ 1, 2, 3 ], "2":[ 4, 5, 6 ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "404":{ "description":"The requested workspace resource does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-assign-batch-post", "x-filename-id":"resource-assign-batch-post" } }, "/resource/{resourceId}/assign/project/{projectId}":{ "post":{ "tags":[ "Resource" ], "summary":"Assign a Resource to a Project", "description":"Send a request to this endpoint to assign a workspace resource to a project.", "operationId":"/resource/{resourceId}/assign/project/{projectId}_assignResourceToProject", "parameters":[ { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested workspace resource does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-{resourceId}-assign-project-{projectId}-post", "x-filename-id":"resource-resourceid-assign-project-projectid-post" } }, "/resource":{ "get":{ "tags":[ "Resource" ], "summary":"View all Resources by Resource Class", "description":"Send a request to this endpoint to view all workspace resources which have a resource class with the {resourceClass} query parameter.", "operationId":"/resource_getResourcesByResourceClass", "parameters":[ { "name":"resourceClass", "in":"query", "description":"The class identifies the item as a resource or a role.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "resource, role" ] } } ], "responses":{ "404":{ "description":"The requested workspace resource or role does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-get", "x-filename-id":"resource-get" }, "put":{ "tags":[ "Resource" ], "summary":"Update a Resource or Role", "description":"Send a request to this endpoint to update a workspace resource.", "operationId":"/resource_update_43", "requestBody":{ "description":"A resource object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceInput", "$ref":"#/components/schemas/ApiEntityResourceInput", "exampleSetFlag":false }, "examples":{ "Update_a_Resource_or_Role_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Resource or Role by Assigning Code Values Using Codes", "description":"Payload to update a resource using a resource ID and codeValuesResource fields such as code value code and code type code", "value":{ "resourceId":324213, "codeValuesResource":[ { "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"Sparky Electric" } ] }, "valueSetFlag":true }, "Update_a_Resource_or_Role_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Resource or Role by Assigning Multiple Code Values Using IDs", "description":"Payload to update a resource using a resource ID and codeValuesResource fields such as code value ID and code type ID.", "value":{ "resourceId":324213, "codeValuesResource":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Update_a_Resource_or_Role_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Resource or Role by Assigning Code Values Using IDs", "description":"Payload to update a resource using a resource ID and codeValuesResource fields such as code value ID and code type ID.", "value":{ "resourceId":324213, "codeValuesResource":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Resource_or_Role_Using_Resource_ID":{ "summary":"Update a Resource or Role Using Resource ID", "description":"Payload to update the status of a resource using a resource ID.", "value":{ "resourceStatus":"INACTIVE", "resourceId":324213 }, "valueSetFlag":true }, "Update_a_Resource_or_Role_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Resource or Role by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update a resource using a resource ID and codeValuesResource fields such as code value code, code type code and parent ID of parent code value.", "value":{ "resourceId":324213, "codeValuesResource":[ { "parentId":298203, "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Mechanical" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input. " }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-put", "x-filename-id":"resource-put" }, "post":{ "tags":[ "Resource" ], "summary":"Create a Resource or Role", "description":"Create a resource or role.", "operationId":"/resource_create_45", "requestBody":{ "description":"A resource object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceInput", "$ref":"#/components/schemas/ApiEntityResourceInput", "exampleSetFlag":false }, "examples":{ "Create_a_Resource_or_Role_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Resource or Role by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a resource or role using a resource name, resource code, resource status, resource class, resource type, project ID, and codeValuesResource fields such as code value code, code type code and parent ID of parent code value", "value":{ "resourceName":"Carpenter", "resourceCode":"Carpenter", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101, "codeValuesResource":[ { "parentId":298203, "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Mechanical" } ] }, "valueSetFlag":true }, "Create_a_Resource_or_Role_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Resource or Role by Assigning Multiple Code Values Using IDs", "description":"Payload to create a resource or role using a resource name, resource code, resource status, resource class, resource type, project ID, and codeValuesResource fields such as code value ID and code type ID", "value":{ "resourceName":"Carpenter", "resourceCode":"Carpenter", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101, "codeValuesResource":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Resource_or_Role_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Resource or Role by Assigning Code Values Using Codes", "description":"Payload to create a resource or role using a resource name, resource code, resource status, resource class, resource type, project ID, and codeValuesResource fields such as code value code and code type code.", "value":{ "resourceName":"Carpenter", "resourceCode":"Carpenter", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101, "codeValuesResource":[ { "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"Sparky Electric" } ] }, "valueSetFlag":true }, "Create_a_Resource_or_Role":{ "summary":"Create a Resource or Role", "description":"Payload to create a resource using a resource name, resource code, resource status, resource class, resource type, and project ID.", "value":{ "resourceName":"Carpenter", "resourceCode":"Carpenter", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input. " }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResource", "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-post", "x-filename-id":"resource-post" } }, "/resource/batch":{ "put":{ "tags":[ "Resource" ], "summary":"Batch Update Resources or Roles", "description":"Send a request to this endpoint to update one or more workspace resources or roles.", "operationId":"/resource/batch_updateBatch_40", "requestBody":{ "description":"A resource object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Resources_or_Roles_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Resources or Roles by Assigning Code Values Using Codes or IDs", "description":"Payload to update the resources using resource IDs and codeValuesResource fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "resourceId":324213, "codeValuesResource":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, { "resourceId":324214, "codeValuesResource":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" } ] } ], "valueSetFlag":true }, "Batch_Update_Resources_or_Roles_Using_Resource_IDs":{ "summary":"Batch Update Resources or Roles Using Resource IDs", "description":"Payload to update the status of one or more resources using resource IDs.", "value":[ { "resourceStatus":"INACTIVE", "resourceId":324213 }, { "resourceStatus":"INACTIVE", "resourceId":324214 } ], "valueSetFlag":true }, "Batch_Update_Resources_or_Roles_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Resources or Roles by Assigning Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the resources using resource IDs and codeValuesResource fields such as code value code, code type code, and parent ID of parent code value.", "value":[ { "resourceId":324213, "codeValuesResource":[ { "parentId":298203, "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Mechanical" } ] }, { "resourceId":324214, "codeValuesResource":[ { "parentId":298203, "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Mechanical" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input. " }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"resource-batch-put", "x-filename-id":"resource-batch-put" }, "post":{ "tags":[ "Resource" ], "summary":"Batch Create Resources or Roles", "description":"Send a request to this endpoint to create one or more workspace resources or roles.", "operationId":"/resource/batch_createBatch_42", "requestBody":{ "description":"A resource object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Resources_or_Roles":{ "summary":"Batch Create Resources or Roles ", "description":"Payload to create one or more resources using resource names, resource codes, resource statuses, resource classes, resource types, and project IDs.", "value":[ { "resourceName":"Carpenter", "resourceCode":"Carpenter", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101 }, { "resourceName":"Steel Fixer", "resourceCode":"Steel Fixer", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101 } ], "valueSetFlag":true }, "Batch_Create_Resources_or_Roles_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Resources or Roles by Assigning Code Values Using Codes ", "description":"Payload to create one or more resources using resource names, resource codes, resource statuses, resource classes, resource types, project IDs, and codeValuesResource fields such as code value code and code type code.", "value":[ { "resourceName":"Carpenter", "resourceCode":"Carpenter", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101, "codeValuesResource":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ] }, { "resourceName":"Steel Fixer", "resourceCode":"Steel Fixer", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101, "codeValuesResource":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" } ] } ], "valueSetFlag":true }, "Batch_Create_Resources_or_Roles_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Resources or Roles by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create one or more resources using resource names, resource codes, resource statuses, resource classes, resource types, project IDs, and codeValuesResource fields such as code value code, code type code, and parent ID of parent code value.", "value":[ { "resourceName":"Carpenter", "resourceCode":"Carpenter", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101, "codeValuesResource":[ { "parentId":298203, "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Mechanical" } ] }, { "resourceName":"Steel Fixer", "resourceCode":"Steel Fixer", "resourceStatus":"ACTIVE", "resourceClass":"RESOURCE", "resourceType":"LABOR", "projectId":222101, "codeValuesResource":[ { "parentId":298203, "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Mechanical" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input. " }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-batch-post", "x-filename-id":"resource-batch-post" }, "delete":{ "tags":[ "Resource" ], "summary":"Batch Delete Resources or Roles", "description":"Send a request to this endpoint to delete one or more resources.", "operationId":"/resource/batch_deleteBatch_40", "requestBody":{ "description":"The system-generated identifier of a resource.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input. " }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-batch-delete", "x-filename-id":"resource-batch-delete" } }, "/resource/{resourceId}":{ "get":{ "tags":[ "Resource" ], "summary":"View a Resource or Role", "description":"Send a request to this endpoint to view a resource or role created at the workspace level.", "operationId":"/resource/{resourceId}_find_61", "parameters":[ { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested workspace resource or role does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResource", "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-{resourceId}-get", "x-filename-id":"resource-resourceid-get" }, "delete":{ "tags":[ "Resource" ], "summary":"Delete a Resource or Role", "description":"Send a request to this endpoint to delete a resource. The application object with an ID value that matches the value of the {resourceId} path parameter will be deleted.", "operationId":"/resource/{resourceId}_delete_43", "parameters":[ { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input. " }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-{resourceId}-delete", "x-filename-id":"resource-resourceid-delete" } }, "/resource/workspaceResource/batch":{ "delete":{ "tags":[ "Resource" ], "summary":"Unassign Workspace Resources or Roles ", "description":"Send a request to this endpoint to unassign one or more resources or roles from given inherited workspaces.
The request body should contain a map where keys are system-generated identifiers of workspaces and values are lists of system-generated identifiers of resources or roles to be unassigned.
Example: {\"workspaceId1\":[resourceId1,resourceId2],\"workspaceId2\":[resourceId3,resourceId4]}", "operationId":"/resource/workspaceResource/batch_deleteWorkspaceResource", "requestBody":{ "description":"Map of system-generated identifier of a workspace and List of system-generated identifiers of resources.
Example: {\"wsId1\":[ResId1,ResId2],\"wsId2\":[ResId3,ResId4]}
", "content":{ "application/json":{ "schema":{ "title":"String", "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "examples":{ "Unassign_Workspace_Resources_or_Roles":{ "summary":"Unassign Workspace Resources or Roles", "description":"Payload to unassign resources from specific workspaces.", "value":{ "1":[ 1, 2, 3 ], "2":[ 4, 5, 6 ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"The requested resource does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-workspaceResource-batch-delete", "x-filename-id":"resource-workspaceresource-batch-delete" } }, "/resource/workspaceResource/workspace/{workspaceId}/resource/{resourceId}":{ "delete":{ "tags":[ "Resource" ], "summary":"Unassign a Workspace Resource or Role ", "description":"Send a request to this endpoint to unassign a resource or role from a inherited workspace.", "operationId":"/resource/workspaceResource/workspace/{workspaceId}/resource/{resourceId}_deleteWorkspaceResource_1", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested resource does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-workspaceResource-workspace-{workspaceId}-resource-{resourceId}-delete", "x-filename-id":"resource-workspaceresource-workspace-workspaceid-resource-resourceid-delete" } }, "/resource/externallySourced":{ "get":{ "tags":[ "Resource" ], "summary":"View all Integrated Resources", "description":"Send a request to this endpoint to view all integrated resources.", "operationId":"/resource/externallySourced_findAllExternallySourced_2", "responses":{ "204":{ "description":"The requested resource does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-externallySourced-get", "x-filename-id":"resource-externallysourced-get" } }, "/resource/code/{resourceCode}/resourceType/{resourceType}":{ "get":{ "tags":[ "Resource" ], "summary":"View all Resources by Code and Type", "description":"Send a request to this endpoint to view all workspace resources which have a resource code with the {resourceCode} path parameter and a resource type with the {resourceType} path parameter. ", "operationId":"/resource/code/{resourceCode}/resourceType/{resourceType}_findByCodeAndResourceClass", "parameters":[ { "name":"resourceCode", "in":"path", "description":"The user-specified identifier of a resource.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"resourceType", "in":"path", "description":"The type of the resource i.e., LABOR, NONLABOR or MATERIAL.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested workspace resource or role does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-code-{resourceCode}-resourceType-{resourceType}-get", "x-filename-id":"resource-code-resourcecode-resourcetype-resourcetype-get" } }, "/resource/byParent":{ "get":{ "tags":[ "Resource" ], "summary":"View all Resources by Parent Code", "description":"Send a request to this endpoint to view all resources under a parent with codes matching the code fields in the query parameters.", "operationId":"/resource/byParent_findByCodesUsingWorkspaceCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Workspace code under which all the resources have to be found.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"No workspace exists with the given workspace code." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-byParent-get", "x-filename-id":"resource-byparent-get" } }, "/resource/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Resource" ], "summary":"View all Resources by Assigned Code Value", "description":"Send a request to this endpoint to view all resources which have a code type with the {codeTypeId} path parameter and a code value with the {codeValueCode} path parameter. ", "operationId":"/resource/codeType/{codeTypeId}/codeValue/{codeValueCode}_findResourcesByCodeValue", "parameters":[ { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested workspace resource or role does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"resource-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/resource/{resourceId}/resourceClass/{resourceClass}/childrenHierarchy":{ "get":{ "tags":[ "Resource" ], "summary":"View all Child Resources and Roles by Resource Hierarchy ", "description":"View all child resources of a resource which have a resource ID with the {resourceId} path parameter and a resource class with the {resourceClass} path parameter.", "operationId":"/resource/{resourceId}/resourceClass/{resourceClass}/childrenHierarchy_getAllChildrenInHierarchyUsingResourceIdAndResourceClass", "parameters":[ { "name":"resourceClass", "in":"path", "description":"ResourceClass to get resources", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "resource, role" ] } }, { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested workspace resource or role does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-{resourceId}-resourceClass-{resourceClass}-childrenHierarchy-get", "x-filename-id":"resource-resourceid-resourceclass-resourceclass-childrenhierarchy-get" } }, "/resource/projectId/{projectId}":{ "get":{ "tags":[ "Resource" ], "summary":"View all Project Resources or Roles by Project ", "description":"This endpoint returns resources that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/resource/projectId/{projectId}_getResourcesAndRolesByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project resource does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-projectId-{projectId}-get", "x-filename-id":"resource-projectid-projectid-get" } }, "/resource/workspace/{workspaceId}":{ "get":{ "tags":[ "Resource" ], "summary":"View all Workspace Resources and Roles by Workspace ", "description":"This endpoint returns resources that meet the following requirements:
  • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/resource/workspace/{workspaceId}_getResourcesAndRolesByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested workspace resource or role does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-workspace-{workspaceId}-get", "x-filename-id":"resource-workspace-workspaceid-get" } }, "/resource/replicateObjectInWorkspaces/resource/{resourceId}/workspace/{workspaceId}":{ "post":{ "tags":[ "Resource" ], "summary":"Assign or Promote a Resource", "description":"Send a request to this endpoint to assign or promote a resource to the provided workspace from an existing project or a workspace.", "operationId":"/resource/replicateObjectInWorkspaces/resource/{resourceId}/workspace/{workspaceId}_replicateResourceInWorkspaceHierarchy", "parameters":[ { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested workspace resource does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-replicateObjectInWorkspaces-resource-{resourceId}-workspace-{workspaceId}-post", "x-filename-id":"resource-replicateobjectinworkspaces-resource-resourceid-workspace-workspaceid-post" } }, "/resource/sync":{ "post":{ "tags":[ "Resource" ], "summary":"Integrate a Resource with an External Data Source", "description":"Send a request to this endpoint to create or update an integrated resource. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/resource/sync_sync_6", "requestBody":{ "description":"The unique identifier of resource data in an external source.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedResourceInput", "$ref":"#/components/schemas/ApiEntityExternallySourcedResourceInput", "exampleSetFlag":false }, "examples":{ "Create_or_Update_Resource_Using_Parent_ID":{ "summary":"Create or Update Resource Using Parent ID", "description":"Payload to create or update workspace resource using the workspace ID, resource code, resource name, resource class, resource type, description, resource status, and resource code values, such as code value code and code type code.", "value":{ "workspaceId":230091, "resourceClass":"RESOURCE", "resourceName":"Carpentor1", "resourceCode":"R11", "resourceType":"LABOR", "sourceId":"120", "resourceStatus":"ACTIVE", "codeValuesResource":[ { "codeValueCode":"CON", "codeTypeCode":"Department" } ] }, "valueSetFlag":true }, "Create_or_Update_Resource_Using_Codes":{ "summary":"Create or Update Resource Using Codes", "description":"Payload to create or update project resource using the workspace code, project code, resource code, resource name, resource class, email address, calendar, unit of measure code, resource type, and status.", "value":{ "workspaceCode":"Ananth Construction", "projectCode":"ATP", "resourceCode":"R10", "resourceName":"Carpentor", "resourceClass":"RESOURCE", "emailAddress":"employee1@abc.com", "unitOfMeasureCode":"UOM", "calendar":0, "resourceType":"MATERIAL", "resourceStatus":"ACTIVE", "sourceId":"100" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityERPSyncApiResponse", "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-sync-post", "x-filename-id":"resource-sync-post" } }, "/resource/syncBatch":{ "post":{ "tags":[ "Resource" ], "summary":"Batch Integrate Resources with an External Data Source", "description":"Send a request to this endpoint to create or update one or more integrated resources. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.", "operationId":"/resource/syncBatch_syncBatch_43", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any resource sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more unique identifiers of resource data in an external source.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedResourceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update Resources_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create or Update Resources by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update one or more project resources using the resourceId, workspace code, project code, resource code, resource name, resource class, email address, calendar, unit of measure code, resource type, status, resourceID, and codeValuesResource fields such as code value code, code type code, and parent ID of parent code value.", "value":[ { "workspaceCode":"Ananth Construction", "projectCode":"ATP", "resourceCode":"R10", "resourceName":"Carpentor", "resourceClass":"RESOURCE", "emailAddress":"employee1@abc.com", "unitOfMeasureCode":"UOM", "calendar":0, "resourceType":"MATERIAL", "resourceStatus":"ACTIVE", "codeValuesResource":[ { "parentId":298203, "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Plumber" } ] }, { "resourceId":324213, "codeValuesResource":[ { "parentId":298203, "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Plumber" } ] } ], "valueSetFlag":true }, "Batch_Create_or_Update_Resources_Using_Parent_ID":{ "summary":"Batch Create or Update Resources Using Parent ID", "description":"Payload to create or update one or more workspace resources using the workspace code, resource code, resource name, resource class, email address, calendar, resource type, description, employee number, resource title name, parent ID, and resource status.", "value":[ { "workspaceId":4001, "resourceClass":"RESOURCE", "resourceName":"Carpentor-1", "resourceCode":"R11", "emailAddress":"employee2@abc.com", "calendar":0, "resourceType":"LABOR", "resourceStatus":"ACTIVE", "description":"resource....", "employeeNumber":"32457", "resourceTitleName":"Mrs", "parentId":6101 } ], "valueSetFlag":true }, "Batch_Create_or_Update Resources_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create or Update Resources by Assigning Code Values Using Codes", "description":"Payload to create or update one or more project resources using the workspace code, project code, resource code, resource name, resource class, email address, calendar, unit of measure code, resource type, status, resourceID, and codeValuesResource fields such as code value code, and code type code.", "value":[ { "workspaceCode":"Ananth Construction", "projectCode":"ATP", "resourceCode":"R10", "resourceName":"Carpentor", "resourceClass":"RESOURCE", "emailAddress":"employee1@abc.com", "unitOfMeasureCode":"UOM", "calendar":0, "resourceType":"MATERIAL", "resourceStatus":"ACTIVE", "codeValuesResource":[ { "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Mechanical" } ] }, { "resourceId":324213, "codeValuesResource":[ { "codeTypeCode":"GENERAL_CONTRACTOR", "codeValueCode":"BB Mechanical" } ] } ], "valueSetFlag":true }, "Batch_Create_or_Update_Resources_Using_Codes":{ "summary":"Batch Create or Update Resources Using Codes", "description":"Payload to create or update one or more project resources using the workspace code, project code, resource code, resource name, resource class, email address, calendar, unit of measure code, resource type, and status.", "value":[ { "workspaceCode":"Ananth Construction", "projectCode":"ATP", "resourceCode":"R10", "resourceName":"Carpentor", "resourceClass":"RESOURCE", "emailAddress":"employee1@abc.com", "unitOfMeasureCode":"UOM", "calendar":0, "resourceType":"MATERIAL", "resourceStatus":"ACTIVE" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resource-syncBatch-post", "x-filename-id":"resource-syncbatch-post" } }, "/resource/unassign/batch":{ "delete":{ "tags":[ "Resource" ], "summary":"Unassign Resources or Roles from Projects", "description":"Send a request to this endpoint to unassign multiple resources or roles from various projects.
The request body should contain a map where keys are system-generated identifiers of projects and values are lists of system-generated identifiers of resources or roles to be unassigned.
Example: {\"projectId1\":[resourceId1,resourceId2],\"projectId2\":[resourceId3,resourceId4]}", "operationId":"/resource/unassign/batch_unAssignResourceFromProject", "requestBody":{ "description":"Map of system-generated identifier of a project and list of system-generated identifiers of resources.
Example: {\"projId1\":[ResId1,ResId2],\"projId2\":[ResId3,ResId4]}
", "content":{ "application/json":{ "schema":{ "title":"String", "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "examples":{ "Unassign_Resources_or_Roles_from_Projects":{ "summary":"Unassign Resources or Roles from Projects", "description":"Payload to unassign resources from specific projects.", "value":{ "1":[ 1, 2, 3 ], "2":[ 4, 5, 6 ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"The requested resource does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-unassign-batch-delete", "x-filename-id":"resource-unassign-batch-delete" } }, "/resource/{resourceId}/unassign/project/{projectId}":{ "delete":{ "tags":[ "Resource" ], "summary":"Unassign a Resource or Role from a Project", "description":"Send a request to this endpoint to unassign a resource or role from a project.", "operationId":"/resource/{resourceId}/unassign/project/{projectId}_unAssignResourceFromProject_1", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested resource does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resource-{resourceId}-unassign-project-{projectId}-delete", "x-filename-id":"resource-resourceid-unassign-project-projectid-delete" } }, "/relationship":{ "put":{ "tags":[ "Activity Relationship" ], "summary":"Update an Activity Relationship", "description":"Send a request to this endpoint to update a activity relationship.", "operationId":"/relationship_update_44", "requestBody":{ "description":"An activity relationship object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRelationshipInput", "$ref":"#/components/schemas/ApiEntityRelationshipInput", "exampleSetFlag":false }, "examples":{ "Update_an_Activity_Relationship":{ "summary":"Update an Activity Relationship Using Activity Relationship ID", "description":"Payload to update critical and status attributes of activity relationship using the activity relationship ID.", "value":{ "relationshipId":1948401, "critical":true, "lagHours":0.1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Relationship service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"relationship-put", "x-filename-id":"relationship-put" }, "post":{ "tags":[ "Activity Relationship" ], "summary":"Create an Activity Relationship", "description":"Send a request to this endpoint to create a activity relationship.", "operationId":"/relationship_create_46", "requestBody":{ "description":"An activity relationship object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRelationshipInput", "$ref":"#/components/schemas/ApiEntityRelationshipInput", "exampleSetFlag":false }, "examples":{ "Create_an_Activity_Relationship":{ "summary":"Create an Activity Relationship", "description":"Payload to create an activity relationship using the predecessor project ID, predecessor activity ID, relationship type, lag hours, successor project ID, successor activity ID.", "value":{ "predActivityId":3024008, "predProjectId":1888907, "relationshipType":"START_TO_START", "succActivityId":3024009, "succProjectId":1888907, "critical":false, "lagHours":0.4 }, "valueSetFlag":true }, "Create_an_Activity_Relationship_Using_Codes":{ "summary":"Create an Activity Relationship Using Codes", "description":"Payload to create an activity relationship using the predecessor project code, predecessor workspace code, predecessor activity code, relationship type, lag hours, successor project code, successor workspace code, successor activity code.", "value":{ "predActivityCode":"A1010", "predProjectCode":"ATP", "predWorkspaceCode":"Ananth Constructions", "relationshipType":"FINISH_TO_START", "succActivityCode":"A1013", "succProjectCode":"ATP", "succWorkspaceCode":"Ananth Constructions", "lagHours":0.2 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Relationship service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRelationship", "$ref":"#/components/schemas/ApiEntityRelationship", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"relationship-post", "x-filename-id":"relationship-post" } }, "/relationship/batch":{ "put":{ "tags":[ "Activity Relationship" ], "summary":"Batch Update Activity Relationships", "description":"Send a request to this endpoint to update one or more activity relationships.", "operationId":"/relationship/batch_updateBatch_41", "requestBody":{ "description":"One or more activity relationship objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRelationshipInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Activity_Relationships":{ "summary":"Update One or More Activity Relationships Using Activity Relationship IDs", "description":"Payload to update one or more activity relationships using activity relationship IDs.", "value":[ { "relationshipId":1948403, "critical":true, "lagHours":0.2 }, { "relationshipId":1948404, "critical":true, "lagHours":0.4 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Relationship service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"relationship-batch-put", "x-filename-id":"relationship-batch-put" }, "post":{ "tags":[ "Activity Relationship" ], "summary":"Batch Create Activity Relationships", "description":"Send a request to this endpoint to create one or more activity relationships.", "operationId":"/relationship/batch_createBatch_43", "requestBody":{ "description":"One or more activity relationship objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRelationshipInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Activity_Relationships":{ "summary":"Batch Create Activity Relationships", "description":"Payload to create one or more activity relationships using the predecessor project ID, predecessor activity ID, relationship type, lag hours, successor project ID, and successor activity ID.", "value":[ { "predActivityId":3024009, "predProjectId":1888907, "relationshipType":"START_TO_FINISH", "succActivityId":3024007, "succProjectId":1888907, "critical":false, "lagHours":1 }, { "predActivityId":3024013, "predProjectId":1888907, "relationshipType":"FINISH_TO_START", "succActivityId":3024008, "succProjectId":1888907, "critical":false, "lagHours":2 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Relationship service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRelationship", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"relationship-batch-post", "x-filename-id":"relationship-batch-post" }, "delete":{ "tags":[ "Activity Relationship" ], "summary":"Batch Delete Activity Relationships", "description":"Send a request to this endpoint to delete one or more activity relationships. ", "operationId":"/relationship/batch_deleteBatch_41", "requestBody":{ "description":"One or more system-generated identifiers of activity relationships.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Relationship service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"relationship-batch-delete", "x-filename-id":"relationship-batch-delete" } }, "/relationship/{relationshipId}":{ "get":{ "tags":[ "Activity Relationship" ], "summary":"View an Activity Relationship", "description":"This endpoint returns activity relationships that meet the following requirements:
  • The object has an ID that matches the value of the {relationshipId} path parameter.
", "operationId":"/relationship/{relationshipId}_find_62", "parameters":[ { "name":"relationshipId", "in":"path", "description":"The system-generated identifier of an activity relationship.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity relationship does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRelationship", "$ref":"#/components/schemas/ApiEntityRelationship", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"relationship-{relationshipId}-get", "x-filename-id":"relationship-relationshipid-get" }, "delete":{ "tags":[ "Activity Relationship" ], "summary":"Delete an Activity Relationship", "description":"Send a request to this endpoint to delete a activity relationship. The application object with an ID value that matches the value of the {relationshipId} path parameter will be deleted.", "operationId":"/relationship/{relationshipId}_delete_44", "parameters":[ { "name":"relationshipId", "in":"path", "description":"The system-generated identifier of an activity relationship.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Activity Relationship service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"relationship-{relationshipId}-delete", "x-filename-id":"relationship-relationshipid-delete" } }, "/relationship/activityRelationshipCode":{ "get":{ "tags":[ "Activity Relationship" ], "summary":"View all Activity Relationships by Parent", "description":"Send a request to this endpoint to view all activity relationships under parent with codes matching the code fields in query parameters.", "operationId":"/relationship/activityRelationshipCode_getActivityRelationshipByProjectCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityCode", "in":"query", "description":"The user-specified identifier of an activity.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity relationship does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRelationship", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"relationship-activityRelationshipCode-get", "x-filename-id":"relationship-activityrelationshipcode-get" } }, "/relationship/activityId/{activityId}":{ "get":{ "tags":[ "Activity Relationship" ], "summary":"View all Activity Relationships Associated to an Activity", "description":"This endpoint returns activity relationships that meet the following requirements:
  • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
", "operationId":"/relationship/activityId/{activityId}_getAllRelationshipsOfActivity", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity relationship does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRelationship", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"relationship-activityId-{activityId}-get", "x-filename-id":"relationship-activityid-activityid-get" } }, "/relationship/projectRelationshipCode":{ "get":{ "tags":[ "Activity Relationship" ], "summary":"View all Project Relationships by Parent", "description":"Send a request to this endpoint to view all project relationships under parent with codes matching the code fields in query parameters.", "operationId":"/relationship/projectRelationshipCode_getProjectRelationshipsByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested activity relationship does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRelationship", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"relationship-projectRelationshipCode-get", "x-filename-id":"relationship-projectrelationshipcode-get" } }, "/relationship/baseline/data":{ "get":{ "tags":[ "Activity Relationship" ], "summary":"View Relationships by Baseline", "description":"Send a request to this endpoint to view all relationships by baseline matching the code fields in query parameters.", "operationId":"/relationship/baseline/data_loadAssignmentsByBaseline_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"baselineName", "in":"query", "description":"The user-specified identifier of a project baseline.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"baselineType", "in":"query", "description":"Identifies the official and unofficial baselines.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CURRENT", "OTHER", "USER_BASELINE_1", "USER_BASELINE_2", "USER_BASELINE_3" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRelationship", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"relationship-baseline-data-get", "x-filename-id":"relationship-baseline-data-get" } }, "/relationship/scheduleScenario/data":{ "get":{ "tags":[ "Activity Relationship" ], "summary":"View Relationships by Schedule Scenario", "description":"Send a request to this endpoint to view all relationships for the schedule scenario matching the code fields in the query parameters.", "operationId":"/relationship/scheduleScenario/data_loadAssignmentsByScenario_1", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scenarioName", "in":"query", "description":"The user-specified identifier of a schedule scenario.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRelationship", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"relationship-scheduleScenario-data-get", "x-filename-id":"relationship-schedulescenario-data-get" } }, "/relationship/syncBatch":{ "post":{ "tags":[ "Activity Relationship" ], "summary":"Batch Sync Activity Relationships", "description":"Send a request to this endpoint to create or update one or more activity relationships.", "operationId":"/relationship/syncBatch_syncBatch_44", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any activity relationship sent as part of the request.
Allowed Values: [ \"true\", \"false\" ].", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more activity relationship objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRelationshipInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_an_Activity_Relationship_Using_Codes":{ "summary":"Create or Update an Activity Relationship Using Codes", "description":"Payload to create or update an activity relationship using the predecessor project code, predecessor workspace code, predecessor activity code, relationship type, lag hours, successor project code, successor workspace code, and successor activity code.", "value":[ { "predActivityCode":"A1010", "predProjectCode":"ATP", "predWorkspaceCode":"Ananth Constructions", "relationshipType":"FINISH_TO_START", "succActivityCode":"A1013", "succProjectCode":"ATP", "succWorkspaceCode":"Ananth Constructions", "lagHours":0.2 } ], "valueSetFlag":true }, "Create_or_Update_an_Activity_Relationship":{ "summary":"Create or Update an Activity Relationship", "description":"Payload to create or update an activity relationship using the predecessor project ID, predecessor activity ID, relationship type, lag hours, successor project ID, and successor activity ID.", "value":[ { "predActivityId":3024008, "predProjectId":1888907, "relationshipType":"START_TO_START", "succActivityId":3024009, "succProjectId":1888907, "critical":false, "lagHours":0.4 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Activity Relationship service. Verify the request contains valid data, then resubmit the request." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"relationship-syncBatch-post", "x-filename-id":"relationship-syncbatch-post" } }, "/report/assignUser":{ "post":{ "tags":[ "Report" ], "summary":"Assign Permission Profiles To User", "description":"Use this endpoint to assign report permission profiles to multiple user.", "operationId":"/report/assignUser_assignUser_6", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when validating any user permission profile sent as part of the request.
Allowed Values: [ \"true\", \"false\" ].", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with report and user profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReportUserPermissions", "$ref":"#/components/schemas/ApiEntityReportUserPermissions", "exampleSetFlag":false }, "examples":{ "Assign_Report_Permission_Profiles_to_Multiple_Users_Using_Codes":{ "summary":"Assign Report Permission Profiles to Multiple Users Using Codes", "description":"Payload to assign report permission to multiple users using workspace ID, report code, and profiles such as report profile ID.", "value":{ "reportCode":"R-10101", "workspaceId":1739401, "profiles":[ { "userName":"manager@example.com", "reportProfileId":"7" }, { "userName":"supervisor@example.com", "reportProfileId":"7" } ] }, "valueSetFlag":true }, "Assign_Report_Permission_Profiles_to_Multiple_Users_Using_IDs":{ "summary":"Assign Report Permission Profiles to Multiple Users Using IDs", "description":"Payload to assign report permission to multiple users using report ID, user name, and profiles such as report profile ID.", "value":{ "reportId":16501, "profiles":[ { "userName":"manager@example.com", "reportProfileId":"7" }, { "userName":"supervisor@example.com", "reportProfileId":"7" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Report service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReportUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityReportUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"report-assignUser-post", "x-filename-id":"report-assignuser-post" } }, "/report/permissionSets":{ "get":{ "tags":[ "Report" ], "summary":"View Available Permission Sets for Report", "description":"Send a request to this endpoint to view the available permission sets for the provided report.", "operationId":"/report/permissionSets_getPermissionSets_6", "parameters":[ { "name":"reportId", "in":"query", "description":"The system-generated identifier of a report.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"reportCode", "in":"query", "description":"The user-defined identifier of a report.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested report does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPermissionSets", "$ref":"#/components/schemas/ApiEntityPermissionSets", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"report-permissionSets-get", "x-filename-id":"report-permissionsets-get" } }, "/reportCycle":{ "put":{ "tags":[ "Report Cycle" ], "summary":"Update a Report Cycle", "description":"Send a request to this endpoint to update a report cycle.", "operationId":"/reportCycle_update_45", "requestBody":{ "description":"One or more report cycle objects.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReportCycleInput", "$ref":"#/components/schemas/ApiEntityReportCycleInput", "exampleSetFlag":false }, "examples":{ "Update_a_Report_Cycle_Using_Report_Cycle_ID":{ "summary":"Update a Report Cycle Using Report Cycle ID", "description":"Payload to update base date of a report cycle using report cycle ID.", "value":{ "reportCycleId":10001, "baseDate":"2022-12-02T00:00:00" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Report Cycle service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"reportCycle-put", "x-filename-id":"reportcycle-put" }, "post":{ "tags":[ "Report Cycle" ], "summary":"Create a Report Cycle", "description":"Send a request to this endpoint to create a report cycle.", "operationId":"/reportCycle_create_47", "requestBody":{ "description":"A report cycle object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReportCycleInput", "$ref":"#/components/schemas/ApiEntityReportCycleInput", "exampleSetFlag":false }, "examples":{ "Create_a_Report_Cycle":{ "summary":"Create a Report Cycle", "description":"Payload to create a report cycle using workspace ID, base date, cycle name, granularity, prefix, period ID, suffix, and suffix increment.", "value":{ "baseDate":"2023-01-01T00:00:00", "cycleName":"Every 1 Week", "granularity":"WEEKLY", "prefix":"WK", "periodId":1400, "suffix":1, "suffixIncrement":1, "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Report Cycle service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReportCycle", "$ref":"#/components/schemas/ApiEntityReportCycle", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"reportCycle-post", "x-filename-id":"reportcycle-post" } }, "/reportCycle/batch":{ "put":{ "tags":[ "Report Cycle" ], "summary":"Batch Update Report Cycles", "description":"Send a request to this endpoint to update one or more report cycles.", "operationId":"/reportCycle/batch_updateBatch_42", "requestBody":{ "description":"One or more report cycle objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReportCycleInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Report_Cycles_Using_Report_Cycle_IDs":{ "summary":"Batch Update Report Cycles Using Report Cycle IDs", "description":"Payload to update base date of one or more report cycles using report cycle IDs.", "value":[ { "reportCycleId":10001, "baseDate":"2022-12-02T00:00:00" }, { "reportCycleId":10002, "baseDate":"2018-12-02T00:00:00" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Report Cycle service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"reportCycle-batch-put", "x-filename-id":"reportcycle-batch-put" }, "post":{ "tags":[ "Report Cycle" ], "summary":"Batch Create Report Cycles", "description":"Send a request to this endpoint to create one or more report cycles. ", "operationId":"/reportCycle/batch_createBatch_44", "requestBody":{ "description":"One or more report cycle objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReportCycleInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Report_Cycles":{ "summary":"Batch Create Report Cycles", "description":"Payload to create one or more report cycles using workspace ID, base date, cycle name, granularity, prefix, period ID, suffix, and suffix increment.", "value":[ { "baseDate":"2015-01-01T00:00:00", "cycleName":"Every 1 Week", "granularity":"WEEKLY", "prefix":"WK", "periodId":1400, "suffix":1, "suffixIncrement":1, "workspaceId":10001 }, { "baseDate":"2015-01-01T00:00:00", "cycleName":"Every 2 Weeks", "granularity":"WEEKLY", "prefix":"WK", "periodId":2700, "suffix":1, "suffixIncrement":1, "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Report Cycle service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReportCycle", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"reportCycle-batch-post", "x-filename-id":"reportcycle-batch-post" }, "delete":{ "tags":[ "Report Cycle" ], "summary":"Batch Delete Report Cycles", "description":"Send a request to this endpoint to delete one or more report cycles. ", "operationId":"/reportCycle/batch_deleteBatch_42", "requestBody":{ "description":"One or more system-generated identifiers of report cycles.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Report Cycle service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"reportCycle-batch-delete", "x-filename-id":"reportcycle-batch-delete" } }, "/reportCycle/{reportCycleId}":{ "get":{ "tags":[ "Report Cycle" ], "summary":"View a Report Cycle", "description":"This endpoint returns report cycles that meet the following requirements:
  • The object has an ID that matches the value of the {reportCycleId} path parameter.
", "operationId":"/reportCycle/{reportCycleId}_find_63", "parameters":[ { "name":"reportCycleId", "in":"path", "description":"The system-generated identifier of a report cycle.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested report cycle does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReportCycle", "$ref":"#/components/schemas/ApiEntityReportCycle", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"reportCycle-{reportCycleId}-get", "x-filename-id":"reportcycle-reportcycleid-get" }, "delete":{ "tags":[ "Report Cycle" ], "summary":"Delete a Report Cycle", "description":"Send a request to this endpoint to delete a report cycle. The application object with an ID value that matches the value of the {reportCycleId} path parameter will be deleted.", "operationId":"/reportCycle/{reportCycleId}_delete_45", "parameters":[ { "name":"reportCycleId", "in":"path", "description":"The system-generated identifier of a report cycle.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Report Cycle service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"reportCycle-{reportCycleId}-delete", "x-filename-id":"reportcycle-reportcycleid-delete" } }, "/reportCycle/workspace/{workspaceId}":{ "get":{ "tags":[ "Report Cycle" ], "summary":"View all Report Cycles by Workspace", "description":"This endpoint returns report cycles that meet the following requirements:
  • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
", "operationId":"/reportCycle/workspace/{workspaceId}_findByWorkspaceId_3", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested report cycle does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReportCycle", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"reportCycle-workspace-{workspaceId}-get", "x-filename-id":"reportcycle-workspace-workspaceid-get" } }, "/reportCycle/syncBatch":{ "post":{ "tags":[ "Report Cycle" ], "summary":"Batch Sync Report Cycles", "description":"Send a request to this endpoint to create or update one or more report cycles.", "operationId":"/reportCycle/syncBatch_syncBatch_45", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any report cycle sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more report cycle objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReportCycleInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Report_Cycles_Using_Workspace_Code":{ "summary":"Batch Create or Update Report Cycles Using Workspace Code", "description":"Payload to create or update one or more report cycles using the workspace code, base date, cycle name, granularity, prefix, period ID, suffix, and suffix increment.", "value":[ { "baseDate":"2023-01-01T00:00:00", "cycleName":"Every 1 Week", "granularity":"WEEKLY", "prefix":"WK", "periodId":1400, "suffix":1, "suffixIncrement":1, "workspaceCode":"Ananth Construction" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Report Cycle service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"reportCycle-syncBatch-post", "x-filename-id":"reportcycle-syncbatch-post" } }, "/resourceDemand":{ "put":{ "tags":[ "Resource Demand" ], "summary":"Update a Resource Demand", "description":"Send a request to this endpoint to update a resource demand.", "operationId":"/resourceDemand_update_46", "requestBody":{ "description":"A resource demand object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceDemandInput", "$ref":"#/components/schemas/ApiEntityResourceDemandInput", "exampleSetFlag":false }, "examples":{ "Update_a_Resource_Demand_Using_Resource_Demand_ID.":{ "summary":"Update a Resource Demand Using Resource Demand ID.", "description":"Payload to update the sequence number of resource demand using the resource demand ID.", "value":{ "resourceDemandId":22001, "sequenceNumber":2 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Demand service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourceDemand-put", "x-filename-id":"resourcedemand-put" }, "post":{ "tags":[ "Resource Demand" ], "summary":"Create a Resource Demand", "description":"Send a request to this endpoint to create a resource demand.", "operationId":"/resourceDemand_create_48", "requestBody":{ "description":"A resource demand object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceDemandInput", "$ref":"#/components/schemas/ApiEntityResourceDemandInput", "exampleSetFlag":false }, "examples":{ "Create_a_Resource_Demand":{ "summary":"Create a Resource Demand", "description":"Payload to create a resource demand using a project ID, resource ID, and sequence number.", "value":{ "projectId":226101, "resourceId":324104, "sequenceNumber":1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Demand service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceDemand", "$ref":"#/components/schemas/ApiEntityResourceDemand", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceDemand-post", "x-filename-id":"resourcedemand-post" } }, "/resourceDemand/batch":{ "put":{ "tags":[ "Resource Demand" ], "summary":"Batch Update Resource Demands", "description":"Send a request to this endpoint to update one or more resource demands.", "operationId":"/resourceDemand/batch_updateBatch_43", "requestBody":{ "description":"One or more resource demand objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceDemandInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Resource_Demands_Using_Resource_Demand_IDs":{ "summary":"Batch Update Resource Demands Using Resource Demand IDs", "description":"Payload to update the sequence number of one or more resource demands using resource demand IDs.", "value":[ { "resourceDemandId":22002, "sequenceNumber":3 }, { "resourceDemandId":22003, "sequenceNumber":4 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Demand service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"resourceDemand-batch-put", "x-filename-id":"resourcedemand-batch-put" }, "post":{ "tags":[ "Resource Demand" ], "summary":"Batch Create Resource Demands", "description":"Send a request to this endpoint to create one or more resource demands. ", "operationId":"/resourceDemand/batch_createBatch_45", "requestBody":{ "description":"One or more resource demand objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceDemandInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Resource_Demands":{ "summary":"Batch Create Resource Demands", "description":"Payload to create one or more resource demands using a project ID, resource ID, and sequence number.", "value":[ { "projectId":226101, "resourceId":324104, "sequenceNumber":1 }, { "projectId":226101, "resourceId":324107, "sequenceNumber":1 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Demand service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceDemand", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceDemand-batch-post", "x-filename-id":"resourcedemand-batch-post" }, "delete":{ "tags":[ "Resource Demand" ], "summary":"Batch Delete Resource Demands", "description":"Send a request to this endpoint to delete one or more resource demands.", "operationId":"/resourceDemand/batch_deleteBatch_43", "requestBody":{ "description":"One or more system-generated identifiers of resource demands.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Demand service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourceDemand-batch-delete", "x-filename-id":"resourcedemand-batch-delete" } }, "/resourceDemand/{resourceDemandId}":{ "get":{ "tags":[ "Resource Demand" ], "summary":"View a Resource Demand", "description":"This endpoint returns resource demands that meet the following requirements:
  • The object has an ID that matches the value of the {resourceDemandId} path parameter.
", "operationId":"/resourceDemand/{resourceDemandId}_find_64", "parameters":[ { "name":"resourceDemandId", "in":"path", "description":"The system-generated identifier of a resource demand.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested resource demand does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceDemand", "$ref":"#/components/schemas/ApiEntityResourceDemand", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceDemand-{resourceDemandId}-get", "x-filename-id":"resourcedemand-resourcedemandid-get" }, "delete":{ "tags":[ "Resource Demand" ], "summary":"Delete a Resource Demand", "description":"Send a request to this endpoint to delete a resource demand. The application object with an ID value that matches the value of the {resourceDemandId} path parameter will be deleted.", "operationId":"/resourceDemand/{resourceDemandId}_delete_46", "parameters":[ { "name":"resourceDemandId", "in":"path", "description":"The system-generated identifier of a resource demand.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Resource Demand service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourceDemand-{resourceDemandId}-delete", "x-filename-id":"resourcedemand-resourcedemandid-delete" } }, "/resourceDemand/project/{projectId}":{ "get":{ "tags":[ "Resource Demand" ], "summary":"View all Resource Demands by Project ID", "description":"This endpoint returns resource demands that meet the following requirements:
  • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
", "operationId":"/resourceDemand/project/{projectId}_findByProject_12", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested resource demand does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceDemand", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceDemand-project-{projectId}-get", "x-filename-id":"resourcedemand-project-projectid-get" } }, "/resourceDemand/syncBatch":{ "post":{ "tags":[ "Resource Demand" ], "summary":"Batch Sync Resource Demands", "description":"Send a request to this endpoint to create or update one or more resource demands.", "operationId":"/resourceDemand/syncBatch_syncBatch_46", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any resource demand record sent as part of the request.
Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more resource demand objects.# RESOURCE PLANNING SCENARIO #", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceDemandInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Resource_Demands_Using_Codes":{ "summary":"Batch Create or Update Resource Demands Using Codes", "description":"Payload to create or update one or more resource demands using the workspace code, project code, resource code, resource class, and sequence number.", "value":[ { "workspaceCode":"Ananth Construction", "projectCode":"ATP", "resourceCode":"R8", "resourceClass":"RESOURCE", "sequenceNumber":1 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline threshold." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceDemand-syncBatch-post", "x-filename-id":"resourcedemand-syncbatch-post" } }, "/resourcePlanningScenario":{ "post":{ "tags":[ "Resource Planning Scenario" ], "summary":"Create a Resource Planning Scenario", "description":"Send a request to this endpoint to create Resource Planning Scenario. An application object will be created using the JSON data provided in the request body.", "operationId":"/resourcePlanningScenario_create_49", "requestBody":{ "description":"A Resource Planning Scenario object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourcePlanningScenarioInput", "$ref":"#/components/schemas/ApiEntityResourcePlanningScenarioInput", "exampleSetFlag":false }, "examples":{ "Create_a_Resource_Planning_Scenario":{ "summary":"Create a Resource Planning Scenario", "description":"Payload to create a resource planning scenario using the scenario name, scenario description, portfolio ID, and plan period.", "value":{ "scenarioDescription":"Scenario descriptions", "planPeriod":2025, "portfolioId":404205, "scenarioName":"Test Planning" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Planning Scenario service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourcePlanningScenario", "$ref":"#/components/schemas/ApiEntityResourcePlanningScenario", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resourcePlanningScenario-post", "x-filename-id":"resourceplanningscenario-post" } }, "/resourcePlanningScenario/{scenarioId}":{ "get":{ "tags":[ "Resource Planning Scenario" ], "summary":"View a Resource Planning Scenario", "description":"This endpoint returns resource planning scenarios that meet the following requirements:
  • The object has an ID value that matches the value of the {scenarioId} path parameter.", "operationId":"/resourcePlanningScenario/{scenarioId}_find_65", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of an Resource Plan Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourcePlanningScenario", "$ref":"#/components/schemas/ApiEntityResourcePlanningScenario", "exampleSetFlag":false }, "exampleSetFlag":false } } }, "404":{ "description":"The requested object does not exist, or you do not have access to it." } }, "x-internal-id":"resourcePlanningScenario-{scenarioId}-get", "x-filename-id":"resourceplanningscenario-scenarioid-get" }, "delete":{ "tags":[ "Resource Planning Scenario" ], "summary":"Delete a Resource Planning Scenario", "description":"Send a request to this endpoint to delete a Resource Planning Scenario. The application object with an ID value that matches the value of the {scenarioId} path parameter will be deleted.", "operationId":"/resourcePlanningScenario/{scenarioId}_delete_47", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of a Resource Planning Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourcePlanningScenario-{scenarioId}-delete", "x-filename-id":"resourceplanningscenario-scenarioid-delete" } }, "/resourcePlanningScenario/batch":{ "delete":{ "tags":[ "Resource Planning Scenario" ], "summary":"Batch Delete Resource Planning Scenarios", "description":"Send a request to this endpoint to delete one or more Resource Planning Scenarios. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/resourcePlanningScenario/batch_deleteBatch_44", "requestBody":{ "description":"List of system-generated identifiers of Resource Planning Scenarios.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourcePlanningScenario-batch-delete", "x-filename-id":"resourceplanningscenario-batch-delete" } }, "/resourcePlanningScenario/planProjects/scenario/{scenarioId}":{ "get":{ "tags":[ "Resource Planning Scenario" ], "summary":"View all Resource Plan Projects", "description":"Send a request to this endpoint to view all resource plan projects in the resource planning scenario.", "operationId":"/resourcePlanningScenario/planProjects/scenario/{scenarioId}_getBudgetPlanProjectsByScenarioId_1", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of an Resource Plan Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourcePlanProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourcePlanningScenario-planProjects-scenario-{scenarioId}-get", "x-filename-id":"resourceplanningscenario-planprojects-scenario-scenarioid-get" } }, "/resourcePlanningScenario/byPortfolioId":{ "get":{ "tags":[ "Resource Planning Scenario" ], "summary":"View All Resource Planning Scenarios by Portfolio and Plan Period", "description":"Send a request to this endpoint to view all Resource Planning Scenarios under portfolio with the Id and planPeriod matching the values in query parameters.", "operationId":"/resourcePlanningScenario/byPortfolioId_getScenariosByPortfolioIdAndPlanPeriod_2", "parameters":[ { "name":"portfolioId", "in":"query", "description":"The system-generated identifier of the portfolio.
    This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"planPeriod", "in":"query", "description":"The period during which resource is allocated to projects within the plan.
    This value determines the year in which resource planning timescales start.
    You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
    After the planning period for a resource plan has been set it cannot be changed.
    This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenario", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourcePlanningScenario-byPortfolioId-get", "x-filename-id":"resourceplanningscenario-byportfolioid-get" } }, "/resourcePlanningScenario/byPortfolioName":{ "get":{ "tags":[ "Resource Planning Scenario" ], "summary":"View All Resource Planning Scenarios by Portfolio Name and Plan Period", "description":"Send a request to this endpoint to view all Resource Planning Scenarios under portfolio with details matching the values in query parameters.", "operationId":"/resourcePlanningScenario/byPortfolioName_getScenariosByPortfolioIdAndPlanPeriod_3", "parameters":[ { "name":"portfolioName", "in":"query", "description":"The name of a portfolio.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.# RESOURCE RATE #
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"planPeriod", "in":"query", "description":"The period during which resource is allocated to projects within the plan.
    This value determines the year in which resource planning timescales start.
    You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
    After the planning period for a resource plan has been set it cannot be changed.
    This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanningScenario", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourcePlanningScenario-byPortfolioName-get", "x-filename-id":"resourceplanningscenario-byportfolioname-get" } }, "/resourcePlanningScenario/refresh/{scenarioId}":{ "put":{ "tags":[ "Resource Planning Scenario" ], "summary":"Refresh a Resource Planning Scenario", "description":"Send a request to this endpoint to refresh a resource planning scenario. Refresh resource planning scenarios to ensure their plan projects contain up to all the linked projects and assigned roles.", "operationId":"/resourcePlanningScenario/refresh/{scenarioId}_refresh_1", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated identifier of an Resource Plan Scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourcePlanningScenario-refresh-{scenarioId}-put", "x-filename-id":"resourceplanningscenario-refresh-scenarioid-put" } }, "/resourcePlanningScenario/updateScenarioStatus":{ "put":{ "tags":[ "Resource Planning Scenario" ], "summary":"Update a Resource Planning Scenario Status", "description":"Send a request to this endpoint to update status of Resource Planning Scenario. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/resourcePlanningScenario/updateScenarioStatus_updateScenarioStatus", "requestBody":{ "description":"A Resource Planning Scenario Status Update object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourcePlanningScenarioStatusInput", "$ref":"#/components/schemas/ApiEntityResourcePlanningScenarioStatusInput", "exampleSetFlag":false }, "examples":{ "Update_Status_of_a_Resource_Planning_Scenario":{ "summary":"Update Status of a Resource Planning Scenario", "description":"Payload to update the status of a resource planning scenario using the portfolio ID, plan period, scenario name, and scenario status.", "value":{ "scenarioStatus":"IN_PLANNING", "planPeriod":2025, "portfolioId":404205, "scenarioName":"Test Planning" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourcePlanningScenario-updateScenarioStatus-put", "x-filename-id":"resourceplanningscenario-updatescenariostatus-put" } }, "/resourceRoleAssignment":{ "put":{ "tags":[ "Resource Role Assignment" ], "summary":"Update a Resource Role Assignment ", "description":"Send a request to this endpoint to update a resource role assignment.", "operationId":"/resourceRoleAssignment_update_47", "requestBody":{ "description":"A resource role assignment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceRoleAssignmentInput", "$ref":"#/components/schemas/ApiEntityResourceRoleAssignmentInput", "exampleSetFlag":false }, "examples":{ "Update_a_Resource_Role_Assignment_Using_Resource_Role_Assignment_ID":{ "summary":"Update a Resource Role Assignment Using Resource Role Assignment ID.", "description":"Payload to update the role ID and resource ID of a resource role assignment using a resource role assignment ID.", "value":{ "resourceRoleAssignmentId":62102, "roleId":324107, "resourceId":324105 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Role Assignment service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourceRoleAssignment-put", "x-filename-id":"resourceroleassignment-put" }, "post":{ "tags":[ "Resource Role Assignment" ], "summary":"Create a Resource Role Assignment", "description":"Send a request to this endpoint to create a reosurce role assignment.", "operationId":"/resourceRoleAssignment_create_50", "requestBody":{ "description":"A resource role assignment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceRoleAssignmentInput", "$ref":"#/components/schemas/ApiEntityResourceRoleAssignmentInput", "exampleSetFlag":false }, "examples":{ "Create_a_Resource_Role_Assignment":{ "summary":"Create a Resource Role Assignment", "description":"Payload to create a resource role assignment using a role ID and a resource ID.", "value":{ "roleId":324104, "resourceId":324105 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Role Assignment service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceRoleAssignment", "$ref":"#/components/schemas/ApiEntityResourceRoleAssignment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceRoleAssignment-post", "x-filename-id":"resourceroleassignment-post" } }, "/resourceRoleAssignment/batch":{ "put":{ "tags":[ "Resource Role Assignment" ], "summary":"Batch Update Resource Role Assignments", "description":"Send a request to this endpoint to update one or more resource role assignments.", "operationId":"/resourceRoleAssignment/batch_updateBatch_44", "requestBody":{ "description":"One or more resource role assignment objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceRoleAssignmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Resource_Role_Assignments_Using_Resource_Role_Assignment_IDs":{ "summary":"Batch Update Resource Role Assignments Using Resource Role Assignment IDs", "description":"Payload to update the role ID and resource ID of one or more resource role assignments using resource role assignment IDs.", "value":[ { "resourceRoleAssignmentId":62102, "roleId":324107, "resourceId":324105 }, { "resourceRoleAssignmentId":62103, "roleId":324104, "resourceId":324105 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Role Assignment service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"resourceRoleAssignment-batch-put", "x-filename-id":"resourceroleassignment-batch-put" }, "post":{ "tags":[ "Resource Role Assignment" ], "summary":"Batch Create Resource Role Assignments", "description":"Send a request to this endpoint to create one or more resource role assignments.", "operationId":"/resourceRoleAssignment/batch_createBatch_46", "requestBody":{ "description":"One or more resource role assignment objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceRoleAssignmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Resource_Role_Assignments":{ "summary":"Batch Create Resource Role Assignments", "description":"Payload to create one or more resource role assignments using role IDs and resource IDs.", "value":[ { "roleId":324104, "resourceId":324105 }, { "roleId":324104, "resourceId":324106 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Role Assignment service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceRoleAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceRoleAssignment-batch-post", "x-filename-id":"resourceroleassignment-batch-post" }, "delete":{ "tags":[ "Resource Role Assignment" ], "summary":"Batch Delete Resource Role Assignments ", "description":"Send a request to this endpoint to delete one or more resource role assignments.", "operationId":"/resourceRoleAssignment/batch_deleteBatch_45", "requestBody":{ "description":"One or more system-generated identifiers of resource role assignments.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Role Assignment service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourceRoleAssignment-batch-delete", "x-filename-id":"resourceroleassignment-batch-delete" } }, "/resourceRoleAssignment/{resourceRoleAssignmentId}":{ "get":{ "tags":[ "Resource Role Assignment" ], "summary":"View a Resource Role Assignment ", "description":"This endpoint returns resource role assignments that meet the following requirements:
    • The object has an ID that matches the value of the {resourceRoleAssignmentId} path parameter.
    ", "operationId":"/resourceRoleAssignment/{resourceRoleAssignmentId}_find_66", "parameters":[ { "name":"resourceRoleAssignmentId", "in":"path", "description":"The system-generated identifier of a resource role assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested resource role assignment does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceRoleAssignment", "$ref":"#/components/schemas/ApiEntityResourceRoleAssignment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceRoleAssignment-{resourceRoleAssignmentId}-get", "x-filename-id":"resourceroleassignment-resourceroleassignmentid-get" }, "delete":{ "tags":[ "Resource Role Assignment" ], "summary":"Delete a Resource Role Assignment ", "description":"Send a request to this endpoint to delete a resource role assignment. The application object with an ID value that matches the value of the {resourceRoleAssignmentId} path parameter will be deleted.", "operationId":"/resourceRoleAssignment/{resourceRoleAssignmentId}_delete_48", "parameters":[ { "name":"resourceRoleAssignmentId", "in":"path", "description":"The system-generated identifier of a resource role assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Resource Role Assignment service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourceRoleAssignment-{resourceRoleAssignmentId}-delete", "x-filename-id":"resourceroleassignment-resourceroleassignmentid-delete" } }, "/resourceRoleAssignment/resource/{resourceId}/role/{roleId}":{ "get":{ "tags":[ "Resource Role Assignment" ], "summary":"View a Resource Role Assignment by Resource and Role ", "description":"This endpoint returns resource role assignments that meet the following requirements:
    • The object has a resource with an ID value that matches the value of the {resourceId} path parameter.
    • The object is associated with a role with an ID value that matches the value of the {roleId} path parameter.
    ", "operationId":"/resourceRoleAssignment/resource/{resourceId}/role/{roleId}_findByResourceIdAndRoleId", "parameters":[ { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"roleId", "in":"path", "description":"The system-generated identifier of a role.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Resource Role Assignment services enables you to create, view, update, and delete assignments between resources and roles. A resource role assignment indicates whether or not a resource is fulfilling a particular role." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceRoleAssignment", "$ref":"#/components/schemas/ApiEntityResourceRoleAssignment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceRoleAssignment-resource-{resourceId}-role-{roleId}-get", "x-filename-id":"resourceroleassignment-resource-resourceid-role-roleid-get" } }, "/resourceRoleAssignment/primaryFlag/{primaryFlag}":{ "get":{ "tags":[ "Resource Role Assignment" ], "summary":"View all Resource Role Assignments by Primary Flag ", "description":"This endpoint returns reosurce role assignments that meet the following requirements:
    • The object is associated with a flag with an ID value that matches the value of the {primaryFlag} path parameter.
    ", "operationId":"/resourceRoleAssignment/primaryFlag/{primaryFlag}_getResourcesAndRolesByProject_1", "parameters":[ { "name":"primaryFlag", "in":"path", "description":"Indicates whether this is resource's primary role or not.
    Allowed Values: [ \"TEMPLATE\", \"PROJECT\", \"GENERIC_PORTFOLIO\", \"IDEA\", \"PROGRAM\", \"STRATEGY\" ]", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The Resource Role Assignment services enables you to create, view, update, and delete assignments between resources and roles. A resource role assignment indicates whether or not a resource is fulfilling a particular role." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceRoleAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceRoleAssignment-primaryFlag-{primaryFlag}-get", "x-filename-id":"resourceroleassignment-primaryflag-primaryflag-get" } }, "/resourceRoleAssignment/resource/{resourceId}":{ "get":{ "tags":[ "Resource Role Assignment" ], "summary":"View all Resource Role Assignments by Resource ", "description":"This endpoint returns resource role assignments that meet the following requirements:
    • The object has a resource with an ID value that matches the value of the {resourceId} path parameter.
    ", "operationId":"/resourceRoleAssignment/resource/{resourceId}_getResourcesAndRolesByResource", "parameters":[ { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Resource Role Assignment services enables you to create, view, update, and delete assignments between resources and roles. A resource role assignment indicates whether or not a resource is fulfilling a particular role." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceRoleAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceRoleAssignment-resource-{resourceId}-get", "x-filename-id":"resourceroleassignment-resource-resourceid-get" } }, "/resourceRoleAssignment/syncBatch":{ "post":{ "tags":[ "Resource Role Assignment" ], "summary":"Batch Sync Resource Role Assignments", "description":"Send a request to this endpoint to create or update one or more Resource Role Assignments.", "operationId":"/resourceRoleAssignment/syncBatch_syncBatch_47", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any resource role assignments sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]# RESOURCE WORK RATE #", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more Resource Role Assignments", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceRoleAssignmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Resource_Role_Assignments_Using_ID":{ "summary":"Batch Create or Update Resource Role Assignments Using ID", "description":"Payload to create or update one or more resource role assignments using the role ID and resource ID.", "value":[ { "roleId":324104, "resourceId":324105 } ], "valueSetFlag":true }, "Batch_Create_or_Update_Resource_Role_Assignments_in_the_Workspace":{ "summary":"Batch Create or Update Resource Role Assignments in the Workspace", "description":"Payload to create or update one or more resource role assignments using the workspace code, proficiency, resource, and role code.", "value":[ { "workspaceCode":"Ananth Constructions", "proficiency":"THREE", "resourceCode":"Carpentor-1", "roleCode":"Site-Incharge" } ], "valueSetFlag":true }, "Batch_Create_or_Update_Resource_Role_Assignments_in_the_Project":{ "summary":"Batch Create or Update Resource Role Assignments in the Project", "description":"Payload to create or update one or more resource role assignments using the project code, workspace code, proficiency, resource code, and role code.", "value":[ { "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "proficiency":"FIVE", "resourceCode":"Carpenter", "roleCode":"Incharger" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceRoleAssignment-syncBatch-post", "x-filename-id":"resourceroleassignment-syncbatch-post" } }, "/resourceWorkRate":{ "put":{ "tags":[ "Resource Work Rate" ], "summary":"Update a Resource Work Rate", "description":"Send a request to this endpoint to update a resource work rate.", "operationId":"/resourceWorkRate_update_48", "requestBody":{ "description":"A resource work rate object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceWorkRateInput", "$ref":"#/components/schemas/ApiEntityResourceWorkRateInput", "exampleSetFlag":false }, "examples":{ "Update_a_Resource_Work_Rate_Using_Resource_Work_Rate_ID":{ "summary":"Update a Resource Work Rate Using Resource Work Rate ID", "description":"Payload to update a max units per time of resource work rate using a resource work rate ID.", "value":{ "resourceWorkRateId":92201, "maxUnitsPerTime":0.5 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Work Rate service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourceWorkRate-put", "x-filename-id":"resourceworkrate-put" }, "post":{ "tags":[ "Resource Work Rate" ], "summary":"Create a Resource Work Rate", "description":"Send a request to this endpoint to create a resource work rate.", "operationId":"/resourceWorkRate_create_51", "requestBody":{ "description":"A resource work rate object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceWorkRateInput", "$ref":"#/components/schemas/ApiEntityResourceWorkRateInput", "exampleSetFlag":false }, "examples":{ "Create_a_Resource_Work_Rate":{ "summary":"Create a Resource Work Rate", "description":"Payload to create a resource work rate using a workspace ID, max units per time, an effective start date, and a resource ID.", "value":{ "workspaceId":206201, "maxUnitsPerTime":1, "effectiveStartDate":"2023-04-23T00:00:00", "resourceId":324203 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Work Rate service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceWorkRate", "$ref":"#/components/schemas/ApiEntityResourceWorkRate", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceWorkRate-post", "x-filename-id":"resourceworkrate-post" } }, "/resourceWorkRate/batch":{ "put":{ "tags":[ "Resource Work Rate" ], "summary":"Batch Update Resource Work Rates", "description":"Send a request to this endpoint to update one or more resource work rates.", "operationId":"/resourceWorkRate/batch_updateBatch_45", "requestBody":{ "description":"One or more resource work rate objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceWorkRateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Resource_Work_Rates_Using_Resource_Work_Rate_IDs":{ "summary":"Batch Update Resource Work Rates Using Resource Work Rate IDs", "description":"Payload to update a max units per time of one or more resource work rates using resource work rate IDs.", "value":[ { "resourceWorkRateId":92202, "maxUnitsPerTime":0.5 }, { "resourceWorkRateId":92203, "maxUnitsPerTime":0.5 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Work Rate service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"resourceWorkRate-batch-put", "x-filename-id":"resourceworkrate-batch-put" }, "post":{ "tags":[ "Resource Work Rate" ], "summary":"Batch Create Resource Work Rates", "description":"Send a request to this endpoint to create one or more resource work rates.", "operationId":"/resourceWorkRate/batch_createBatch_47", "requestBody":{ "description":"One or more resource work rate objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceWorkRateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Resource_Work_Rates":{ "summary":"Batch Create Resource Work Rates", "description":"Payload to create one or more resource work rates using a workspace ID, max units per time, an effective start date, and a resource ID.", "value":[ { "workspaceId":206201, "maxUnitsPerTime":1, "effectiveStartDate":"2023-05-23T00:00:00", "resourceId":324203 }, { "workspaceId":206201, "maxUnitsPerTime":1, "effectiveStartDate":"2023-06-23T00:00:00", "resourceId":324203 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Work Rate service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceWorkRate-batch-post", "x-filename-id":"resourceworkrate-batch-post" }, "delete":{ "tags":[ "Resource Work Rate" ], "summary":"Batch Delete Resource Work Rates ", "description":"Send a request to this endpoint to delete one or more resource work rates.", "operationId":"/resourceWorkRate/batch_deleteBatch_46", "requestBody":{ "description":"One or more system-generated identifiers of resource work rates.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Resource Work Rate service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourceWorkRate-batch-delete", "x-filename-id":"resourceworkrate-batch-delete" } }, "/resourceWorkRate/{resourceWorkRateId}":{ "get":{ "tags":[ "Resource Work Rate" ], "summary":"View a Resource Work Rate ", "description":"This endpoint returns resource work rates that meet the following requirements:
    • The object has an ID that matches the value of the {resourceWorkRateId} path parameter.
    ", "operationId":"/resourceWorkRate/{resourceWorkRateId}_find_67", "parameters":[ { "name":"resourceWorkRateId", "in":"path", "description":"The system-generated identifier of a resource work rate.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested resource work rate does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityResourceWorkRate", "$ref":"#/components/schemas/ApiEntityResourceWorkRate", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceWorkRate-{resourceWorkRateId}-get", "x-filename-id":"resourceworkrate-resourceworkrateid-get" }, "delete":{ "tags":[ "Resource Work Rate" ], "summary":"Delete a Resource Work Rate", "description":"Send a request to this endpoint to delete a resource work rate. The application object with an ID value that matches the value of the {resourceWorkRateId} path parameter will be deleted.", "operationId":"/resourceWorkRate/{resourceWorkRateId}_delete_49", "parameters":[ { "name":"resourceWorkRateId", "in":"path", "description":"One or more system-generated identifiers of resource work rates.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Resource Work Rate service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"resourceWorkRate-{resourceWorkRateId}-delete", "x-filename-id":"resourceworkrate-resourceworkrateid-delete" } }, "/resourceWorkRate/resource/{resourceId}":{ "get":{ "tags":[ "Resource Work Rate" ], "summary":"View all Resource Work Rates by Resource ", "description":"This endpoint returns resource work rates that meet the following requirements:
    • The object has a resource with an ID value that matches the value of the {resourceId} path parameter.
    ", "operationId":"/resourceWorkRate/resource/{resourceId}_findByResource", "parameters":[ { "name":"resourceId", "in":"path", "description":"The system-generated identifier of a resource.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested resource work rate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceWorkRate-resource-{resourceId}-get", "x-filename-id":"resourceworkrate-resource-resourceid-get" } }, "/resourceWorkRate/workspace/{workspaceId}":{ "get":{ "tags":[ "Resource Work Rate" ], "summary":"View all Resource Work Rates by Workspace", "description":"Send a request to this endpoint to view the work rates of all resources belonging to a workspace with an ID value that matches the value of the {workspaceId} path parameter.", "operationId":"/resourceWorkRate/workspace/{workspaceId}_findByWorspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested resource work rate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceWorkRate-workspace-{workspaceId}-get", "x-filename-id":"resourceworkrate-workspace-workspaceid-get" } }, "/resourceWorkRate/workspaceCode/{workspaceCode}":{ "get":{ "tags":[ "Resource Work Rate" ], "summary":"View all Resource Work Rates by Workspace Code", "description":"Send a request to this endpoint to view the work rates of all resources belonging to a workspace with a code value that matches the value of the {workspaceCode} path parameter.", "operationId":"/resourceWorkRate/workspaceCode/{workspaceCode}_findByWorspaceCode", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested resource work rate does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceWorkRate", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceWorkRate-workspaceCode-{workspaceCode}-get", "x-filename-id":"resourceworkrate-workspacecode-workspacecode-get" } }, "/resourceWorkRate/syncBatch":{ "post":{ "tags":[ "Resource Work Rate" ], "summary":"Batch Sync Resource Work Rates", "description":"Send a request to this endpoint to create or update one or more resource work rates.", "operationId":"/resourceWorkRate/syncBatch_syncBatch_48", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any resource work rate record sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more resource work rate objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceWorkRateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Resource_Work_Rate":{ "summary":"Create or Update a Resource Work Rate", "description":"Payload to create or update a resource work rate using a workspace ID, max units per time, an effective start date, and a resource ID.", "value":[ { "workspaceId":206201, "maxUnitsPerTime":1, "effectiveStartDate":"2023-04-23T00:00:00", "resourceId":324203 } ], "valueSetFlag":true }, "Create_or_Update_a_Resource_Work_Rate_Using_Price_Per_Unit":{ "summary":"Create or Update a Resource Work Rate Using Price Per Unit", "description":"Payload to create or update a resource work rate using a workspace ID, max units per time, an effective start date, price per unit, and a resource ID.", "value":[ { "workspaceId":206201, "maxUnitsPerTime":1, "effectiveStartDate":"2023-04-23T00:00:00", "resourceId":324203, "resourceWorkRateCost":{ "pricePerUnit2":20, "pricePerUnit1":10 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"resourceWorkRate-syncBatch-post", "x-filename-id":"resourceworkrate-syncbatch-post" } }, "/riskMatrix":{ "put":{ "tags":[ "Risk Matrix" ], "summary":"Update a Risk Matrix", "description":"Send a request to this endpoint to update a risk matrix.", "operationId":"/riskMatrix_update_49", "requestBody":{ "description":"A risk matrix object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMatrixInput", "$ref":"#/components/schemas/ApiEntityRiskMatrixInput", "exampleSetFlag":false }, "examples":{ "Update_a_Risk_Matrix_Using_Risk_Matrix_ID":{ "summary":"Update a Risk Matrix Using Risk Matrix ID", "description":"Payload to update the risk matrix by adding user-type risk score type (threshold) using the risk matrix ID.", "value":{ "riskMatrixId":294001, "scoreTypes":[ { "riskScoreTypeName":"Quality Threshold (5 level)" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskMatrix-put", "x-filename-id":"riskmatrix-put" }, "post":{ "tags":[ "Risk Matrix" ], "summary":"Create a Risk Matrix", "description":"Send a request to this endpoint to create a risk matrix.", "operationId":"/riskMatrix_create_52", "requestBody":{ "description":"A risk matrix object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMatrixInput", "$ref":"#/components/schemas/ApiEntityRiskMatrixInput", "exampleSetFlag":false }, "examples":{ "Create_a_Risk_Matrix":{ "summary":"Create a Risk Matrix", "description":"Payload to create a risk matrix using the matrix name, workspace ID, risk score matrix method, and score types (thresholds).", "value":{ "matrixName":"Cordova Risk Scoring Matrix", "workspaceId":726701, "riskScoreMatrixMethod":"AVERAGE_IMPACTS", "scoreTypes":[ { "riskScoreTypeName":"Cordova Schedule Threshold" }, { "riskScoreTypeName":"Cordova Cost Threshold" }, { "riskScoreTypeName":"Cordova Probability Threshold" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMatrix", "$ref":"#/components/schemas/ApiEntityRiskMatrix", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-post", "x-filename-id":"riskmatrix-post" } }, "/riskMatrix/batch":{ "put":{ "tags":[ "Risk Matrix" ], "summary":"Batch Update Risk Matrices", "description":"Send a request to this endpoint to update one or more risk matrixes.", "operationId":"/riskMatrix/batch_updateBatch_46", "requestBody":{ "description":"One or more risk matrix objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrixInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Risk_Matrices_Using_Risk_Matrix_IDs":{ "summary":"Batch Update Risk Matrices Using Risk Matrix IDs", "description":"Payload to update the matrix descriptions of one or more risk matrices using the risk matrix IDs. ", "value":[ { "riskMatrixId":298001, "matrixDescription":"Risk levels associated with Harbour Pointe" }, { "riskMatrixId":294001, "matrixDescription":"Risk levels associated with Cordova" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"riskMatrix-batch-put", "x-filename-id":"riskmatrix-batch-put" }, "post":{ "tags":[ "Risk Matrix" ], "summary":"Batch Create Risk Matrices", "description":"Send a request to this endpoint to create one or more risk matrixes.", "operationId":"/riskMatrix/batch_createBatch_48", "requestBody":{ "description":"One or more risk matrix objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrixInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Risk_Matrices":{ "summary":"Batch Create Risk Matrices", "description":"Payload to create risk matrices using the matrix names, workspace IDs, risk score matrix methods, and score types (thresholds).", "value":[ { "workspaceId":726701, "matrixName":"Harbour Pointe Risk Scoring Matrix", "riskScoreMatrixMethod":"HIGHEST", "scoreTypes":[ { "riskScoreTypeName":"Harbour Pointe Schedule Threshold" }, { "riskScoreTypeName":"Harbour Pointe Cost Threshold" }, { "riskScoreTypeName":"Harbour Pointe Probability Threshold" } ] }, { "matrixName":"Cordova Risk Scoring Matrix", "workspaceId":726701, "riskScoreMatrixMethod":"AVERAGE_IMPACTS", "scoreTypes":[ { "riskScoreTypeName":"Cordova Schedule Threshold" }, { "riskScoreTypeName":"Cordova Cost Threshold" }, { "riskScoreTypeName":"Cordova Probability Threshold" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrix", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-batch-post", "x-filename-id":"riskmatrix-batch-post" }, "delete":{ "tags":[ "Risk Matrix" ], "summary":"Batch Delete Risk Matrices", "description":"Send a request to this endpoint to delete one or more risk matrixes.", "operationId":"/riskMatrix/batch_deleteBatch_47", "requestBody":{ "description":"One or more system-generated identifiers of a risk matrix.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskMatrix-batch-delete", "x-filename-id":"riskmatrix-batch-delete" } }, "/riskMatrix/{riskMatrixId}":{ "get":{ "tags":[ "Risk Matrix" ], "summary":"View a Risk Matrix", "description":"This endpoint returns risk matrixes that meet the following requirements:
    • The object has an ID that matches the value of the {riskMatrixId} path parameter.
    ", "operationId":"/riskMatrix/{riskMatrixId}_find_68", "parameters":[ { "name":"riskMatrixId", "in":"path", "description":"The system-generated identifier of a risk matrix.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk matrix does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMatrix", "$ref":"#/components/schemas/ApiEntityRiskMatrix", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-{riskMatrixId}-get", "x-filename-id":"riskmatrix-riskmatrixid-get" }, "delete":{ "tags":[ "Risk Matrix" ], "summary":"Delete a Risk Matrix", "description":"Send a request to this endpoint to delete a risk matrix. The application object with an ID value that matches the value of the {riskMatrixId} path parameter will be deleted.", "operationId":"/riskMatrix/{riskMatrixId}_delete_50", "parameters":[ { "name":"riskMatrixId", "in":"path", "description":"The system-generated identifier of a risk matrix.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskMatrix-{riskMatrixId}-delete", "x-filename-id":"riskmatrix-riskmatrixid-delete" } }, "/riskMatrix/name/{matrixName}":{ "get":{ "tags":[ "Risk Matrix" ], "summary":"View a Risk Matrix by Name", "description":"This endpoint returns risk matrixes that meet the following requirements:
    • The object has a name that matches the value of the {matrixName} path parameter.
    ", "operationId":"/riskMatrix/name/{matrixName}_findByName_11", "parameters":[ { "name":"matrixName", "in":"path", "description":"The name of a risk matrix.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk matrix does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrix", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-name-{matrixName}-get", "x-filename-id":"riskmatrix-name-matrixname-get" } }, "/riskMatrix/workspace/{workspaceId}/name/{matrixName}":{ "get":{ "tags":[ "Risk Matrix" ], "summary":"View a Risk Matrix by Name and Workspace", "description":"This endpoint returns risk matrixes that meet the following requirements:
    • The object has a name that matches the value of the {matrixName} path parameter.
    • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
    ", "operationId":"/riskMatrix/workspace/{workspaceId}/name/{matrixName}_findByNameAndWorkspace_1", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"matrixName", "in":"path", "description":"The name of a risk matrix.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk matrix does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMatrix", "$ref":"#/components/schemas/ApiEntityRiskMatrix", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-workspace-{workspaceId}-name-{matrixName}-get", "x-filename-id":"riskmatrix-workspace-workspaceid-name-matrixname-get" } }, "/riskMatrix/workspace/{workspaceId}":{ "get":{ "tags":[ "Risk Matrix" ], "summary":"View Risk Matrices by Workspace", "description":"This endpoint returns risk matrixes that meet the following requirements:
    • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
    ", "operationId":"/riskMatrix/workspace/{workspaceId}_getRiskMatricesByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk matrix does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrix", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-workspace-{workspaceId}-get", "x-filename-id":"riskmatrix-workspace-workspaceid-get" } }, "/riskMatrix/program/{programId}":{ "get":{ "tags":[ "Risk Matrix" ], "summary":"View Risk Matrix by Program", "description":"Send a request to this endpoint to view the risk matrix assigned to the program.", "operationId":"/riskMatrix/program/{programId}_getRiskMatrixByProgram", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk matrix does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMatrix", "$ref":"#/components/schemas/ApiEntityRiskMatrix", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-program-{programId}-get", "x-filename-id":"riskmatrix-program-programid-get" } }, "/riskMatrix/project/{projectId}":{ "get":{ "tags":[ "Risk Matrix" ], "summary":"View Risk Matrix by Project", "description":"Send a request to this endpoint to view the risk matrix assigned to the project.", "operationId":"/riskMatrix/project/{projectId}_getRiskMatrixByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk matrix does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMatrix", "$ref":"#/components/schemas/ApiEntityRiskMatrix", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-project-{projectId}-get", "x-filename-id":"riskmatrix-project-projectid-get" } }, "/riskMatrix/resolveRiskMatrix/workspace/{workspaceId}/riskMatrix/{matrixName}":{ "get":{ "tags":[ "Risk Matrix" ], "summary":"View all Risk Matrixes by Name in a Workspace Hierarchy", "description":"Send a request to this endpoint to view a risk matrix associated with a name matching the value of the {matrixName} and the hierarchy of the workspace with an id matching the value of the {workspaceId}.", "operationId":"/riskMatrix/resolveRiskMatrix/workspace/{workspaceId}/riskMatrix/{matrixName}_resolveRiskScoreTypeInWorkspaceHierarchy", "parameters":[ { "name":"workspaceId", "in":"path", "description":"WorkspaceId of RiskMatrix to be found", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"matrixName", "in":"path", "description":"The name of a risk matrix.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk matrix does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrix", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-resolveRiskMatrix-workspace-{workspaceId}-riskMatrix-{matrixName}-get", "x-filename-id":"riskmatrix-resolveriskmatrix-workspace-workspaceid-riskmatrix-matrixname-get" } }, "/riskMatrix/syncBatch":{ "post":{ "tags":[ "Risk Matrix" ], "summary":"Batch Sync Risk Matrices", "description":"Send a request to this endpoint to create or update one or more risk matrices.", "operationId":"/riskMatrix/syncBatch_syncBatch_49", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any risk matrix sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more risk matrix objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrixInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Integrate_Risk_Matrices":{ "summary":"Create or Update Risk Matrix", "description":"Payload to create or update risk matrices using the matrix names, workspace IDs, risk score matrix methods, and score types (thresholds).", "value":[ { "workspaceId":726701, "matrixName":"Maintenance Risk Scoring Matrix", "riskScoreMatrixMethod":"HIGHEST", "scoreTypes":[ { "riskScoreTypeName":"Maintenance Schedule Impact" }, { "riskScoreTypeName":"Maintenance Cost Impact" }, { "riskScoreTypeName":"Maintenance Probability" } ] }, { "matrixName":"Tech Projects Risk Scoring Matrix", "workspaceId":726701, "riskScoreMatrixMethod":"AVERAGE_IMPACTS", "scoreTypes":[ { "riskScoreTypeName":"Tech Projects Schedule Threshold" }, { "riskScoreTypeName":"Tech Projects Cost Threshold" }, { "riskScoreTypeName":"Tech Projects Probability Threshold" } ] } ], "valueSetFlag":true }, "Batch_Create_or_Update_Risk_Matrices_Using_Workspace Code":{ "summary":"Batch Create or Update Risk Matrices Using Workspace Code", "description":"Payload to create or update risk matrices using the matrix name, workspace code, risk score matrix method, push-down type, and score types (thresholds).", "value":[ { "matrixName":"Cordova Risk Scoring Matrix", "workspaceCode":"North America", "riskScoreMatrixMethod":"AVERAGE_IMPACTS", "pushDownType":"MANUAL", "scoreTypes":[ { "riskScoreTypeName":"Cordova Schedule Threshold" }, { "riskScoreTypeName":"Cordova Cost Threshold" }, { "riskScoreTypeName":"Cordova Probability Threshold" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMatrix-syncBatch-post", "x-filename-id":"riskmatrix-syncbatch-post" } }, "/riskMitigation":{ "put":{ "tags":[ "Project Risk Mitigation" ], "summary":"Update a Project Risk Mitigation", "description":"Send a request to this endpoint to update a project risk mitigation.", "operationId":"/riskMitigation_update_50", "requestBody":{ "description":"A risk mitigation object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMitigationInput", "$ref":"#/components/schemas/ApiEntityRiskMitigationInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Risk_Mitigation_Using_Risk_Mitigation_ID":{ "summary":"Update a Project Risk Mitigation Using Risk Mitigation ID", "description":"Payload to update the end date of a project risk mitigation using the project risk mitigation ID.", "value":{ "riskMitigationId":78003, "finishDate":"2023-03-20T00:00:00" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskMitigation-put", "x-filename-id":"riskmitigation-put" }, "post":{ "tags":[ "Project Risk Mitigation" ], "summary":"Create a Project Risk Mitigation", "description":"Send a request to this endpoint to create a project risk mitigation.", "operationId":"/riskMitigation_create_53", "requestBody":{ "description":"A risk mitigation object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMitigationInput", "$ref":"#/components/schemas/ApiEntityRiskMitigationInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Risk_Mitigation":{ "summary":"Create a Project Risk Mitigation", "description":"Payload to create a project risk mitigation using the project risk ID, project risk mitigation code, name, status, and start and end dates.", "value":{ "projectRiskId":72101, "riskMitigationCode":"1", "riskMitigationName":"Apply drainage and stone to areas impacted", "mitigationStatus":"NOT_STARTED", "startDate":"2023-03-06T00:00:00", "finishDate":"2023-03-25T00:00:00" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMitigation", "$ref":"#/components/schemas/ApiEntityRiskMitigation", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMitigation-post", "x-filename-id":"riskmitigation-post" } }, "/riskMitigation/batch":{ "put":{ "tags":[ "Project Risk Mitigation" ], "summary":"Batch Update Project Risk Mitigations", "description":"Send a request to this endpoint to update one or more project risk mitigations.", "operationId":"/riskMitigation/batch_updateBatch_47", "requestBody":{ "description":"A risk mitigation object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMitigationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Risk_Mitigations_Using_Risk_Mitigation_IDs":{ "summary":"Batch Update Project Risk Mitigations Using Risk Mitigation IDs", "description":"Payload to update the end dates of one or more project risk mitigations using the project risk mitigation IDs.", "value":[ { "riskMitigationId":78003, "finishDate":"2023-03-20T00:00:00" }, { "riskMitigationId":78004, "finishDate":"2023-03-25T00:00:00" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"riskMitigation-batch-put", "x-filename-id":"riskmitigation-batch-put" }, "post":{ "tags":[ "Project Risk Mitigation" ], "summary":"Batch Create Project Risk Mitigations", "description":"Send a request to this endpoint to create one or more project risk mitigations.", "operationId":"/riskMitigation/batch_createBatch_49", "requestBody":{ "description":"One or more risk mitigation objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMitigationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Risk_Mitigations":{ "summary":"Batch Create Project Risk Mitigations", "description":"Payload to create one or more project risk mitigations using the project risk IDs, project risk mitigation codes, names, statuses, and start and end dates.", "value":[ { "projectRiskId":72101, "riskMitigationCode":"1", "riskMitigationName":"Apply drainage and stone to areas impacted", "mitigationStatus":"NOT_STARTED", "startDate":"2023-03-06T00:00:00", "finishDate":"2023-03-25T00:00:00" }, { "projectRiskId":72101, "riskMitigationCode":"2", "riskMitigationName":"Slope the grade away from the area", "mitigationStatus":"NOT_STARTED", "startDate":"2023-03-06T00:00:00", "finishDate":"2023-03-25T00:00:00" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMitigation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMitigation-batch-post", "x-filename-id":"riskmitigation-batch-post" }, "delete":{ "tags":[ "Project Risk Mitigation" ], "summary":"Batch Delete Project Risk Mitigations", "description":"Send a request to this endpoint to delete one or more project risk mitigations.", "operationId":"/riskMitigation/batch_deleteBatch_48", "requestBody":{ "description":"The system-generated identifier of a risk mitigation.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskMitigation-batch-delete", "x-filename-id":"riskmitigation-batch-delete" } }, "/riskMitigation/{riskMitigationId}":{ "get":{ "tags":[ "Project Risk Mitigation" ], "summary":"View a Project Risk Mitigation", "description":"This endpoint returns project risk mitigations that meet the following requirements:
    • The object has an ID that matches the value of the {riskMitigationId} path parameter.
    ", "operationId":"/riskMitigation/{riskMitigationId}_find_69", "parameters":[ { "name":"riskMitigationId", "in":"path", "description":"The system-generated identifier of a risk mitigation.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project risk mitigation does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMitigation", "$ref":"#/components/schemas/ApiEntityRiskMitigation", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMitigation-{riskMitigationId}-get", "x-filename-id":"riskmitigation-riskmitigationid-get" }, "delete":{ "tags":[ "Project Risk Mitigation" ], "summary":"Delete a Project Risk Mitigation", "description":"Send a request to this endpoint to delete a project risk mitigation. The application object with an ID value that matches the value of the {riskMitigationId} path parameter will be deleted.", "operationId":"/riskMitigation/{riskMitigationId}_delete_51", "parameters":[ { "name":"riskMitigationId", "in":"path", "description":"The system-generated identifier of a risk mitigation.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskMitigation-{riskMitigationId}-delete", "x-filename-id":"riskmitigation-riskmitigationid-delete" } }, "/riskMitigation/code/{riskMitigationCode}":{ "get":{ "tags":[ "Project Risk Mitigation" ], "summary":"View all Project Risk Mitigations by Code", "description":"This endpoint returns project risk mitigations that meet the following requirements:
    • The object has a code that matches the value of the {riskMitigationCode} path parameter.
    ", "operationId":"/riskMitigation/code/{riskMitigationCode}_findByCode_13", "parameters":[ { "name":"riskMitigationCode", "in":"path", "description":"The user-specified identifier of a risk mitigation.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project risk mitigation does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMitigation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMitigation-code-{riskMitigationCode}-get", "x-filename-id":"riskmitigation-code-riskmitigationcode-get" } }, "/riskMitigation/projectRisk/{projectRiskId}/code/{riskMitigationCode}":{ "get":{ "tags":[ "Project Risk Mitigation" ], "summary":"View a Project Risk Mitigation by Code and Project Risk", "description":"This endpoint returns project risk mitigations that meet the following requirements:
    • The object has a code that matches the value of the {riskMitigationCode} path parameter.
    • The object is associated with a project risk with an ID value that matches the value of the {projectRiskId} path parameter.
    ", "operationId":"/riskMitigation/projectRisk/{projectRiskId}/code/{riskMitigationCode}_findByCodeAndProjectRisk", "parameters":[ { "name":"projectRiskId", "in":"path", "description":"The system-generated identifier of a project risk.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"riskMitigationCode", "in":"path", "description":"The user-specified identifier of a risk mitigation.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project risk mitigation does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskMitigation", "$ref":"#/components/schemas/ApiEntityRiskMitigation", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMitigation-projectRisk-{projectRiskId}-code-{riskMitigationCode}-get", "x-filename-id":"riskmitigation-projectrisk-projectriskid-code-riskmitigationcode-get" } }, "/riskMitigation/project/{projectId}":{ "get":{ "tags":[ "Project Risk Mitigation" ], "summary":"View all Project Risk Mitigations by Project ID", "description":"This endpoint will fetch a project risk mitigation with a corresponding risk that belongs to the project with a project ID that matches the ID passed as the path parameter.", "operationId":"/riskMitigation/project/{projectId}_findByProjectId_5", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMitigation", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMitigation-project-{projectId}-get", "x-filename-id":"riskmitigation-project-projectid-get" } }, "/riskMitigation/syncBatch":{ "post":{ "tags":[ "Project Risk Mitigation" ], "summary":"Batch Sync Project Risk Mitigations", "description":"Send a request to this endpoint to create or update one or more project risk mitigations.", "operationId":"/riskMitigation/syncBatch_syncBatch_50", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any project risk mitigation sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more risk mitigation objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMitigationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Risk_Mitigations_Using_Activity_ID":{ "summary":"Batch Create or Update Risk Mitigations Using Activity ID", "description":"Payload to create or update one or more risk mitigations using the project code, activity ID, workspace code, risk code, mitigation name, and code.", "value":[ { "projectCode":"ATP", "workspaceCode":"Ananth Construction", "riskCode":"R01", "riskMitigationName":"Apply drainage and stone to areas--impacted", "riskMitigationCode":"1", "activityId":14001 } ], "valueSetFlag":true }, "Batch_Create_or_Update_Risk_Mitigations_Using_Project_Risk_ID":{ "summary":"Batch Create or Update Risk Mitigations Using Project Risk ID", "description":"Payload to create or update one or more risk mitigations using the project risk ID, mitigation status, risk code, risk mitigation name, risk mitigation code, and risk mitigation financial fields such as remaining total cost, and start and end dates.", "value":[ { "projectRiskId":72101, "riskMitigationCode":"1", "riskMitigationName":"Apply drainage and stone to areas impacted-1", "mitigationStatus":"PROPOSED", "startDate":"2023-03-06T00:00:00", "finishDate":"2023-03-25T00:00:00", "riskMitigationFinancial":{ "remainingTotalCost":200 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskMitigation-syncBatch-post", "x-filename-id":"riskmitigation-syncbatch-post" } }, "/riskScoreType":{ "put":{ "tags":[ "Risk Score Type" ], "summary":"Update a Risk Score Type", "description":"Send a request to this endpoint to update a risk score type.", "operationId":"/riskScoreType_update_51", "requestBody":{ "description":"A risk score type object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskScoreTypeInput", "$ref":"#/components/schemas/ApiEntityRiskScoreTypeInput", "exampleSetFlag":false }, "examples":{ "Update_a_Risk_Score_Type_Using_Risk_Score_Type_ID":{ "summary":"Update a Risk Score Type Using Risk Score Type ID", "description":"Payload to update the color in the risk threshold using the risk score type ID and level.", "value":{ "riskScoreTypeId":302106, "riskScoreThresholds":[ { "color":"d72222" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskScoreType-put", "x-filename-id":"riskscoretype-put" }, "post":{ "tags":[ "Risk Score Type" ], "summary":"Create a Risk Score Type", "description":"Send a request to this endpoint to create a risk score type.", "operationId":"/riskScoreType_create_54", "requestBody":{ "description":"A risk score type object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskScoreTypeInput", "$ref":"#/components/schemas/ApiEntityRiskScoreTypeInput", "exampleSetFlag":false }, "examples":{ "Create_a_Risk Score Type Using Workspace ID":{ "summary":"Create a Risk Score Type Using Workspace ID", "description":"Payload to create a risk score type (threshold) using the workspace ID, score type, risk score type name, and risk score thresholds, such as color, level, lower, upper, and risk score threshold name and code.", "value":{ "riskScoreTypeName":"Maintenance Probability", "workspaceId":726701, "scoreType":"PROBABILITY", "riskScoreThresholds":[ { "color":"bdbdbd", "level":0, "riskScoreThresholdCode":"N", "riskScoreThresholdName":"Negligible" }, { "color":"00857C", "lower":0, "upper":20, "level":1, "riskScoreThresholdCode":"VL", "riskScoreThresholdName":"Very Low" }, { "color":"008000", "lower":20, "upper":40, "level":2, "riskScoreThresholdCode":"L", "riskScoreThresholdName":"Low" }, { "color":"F9AA01", "lower":40, "upper":60, "level":3, "riskScoreThresholdCode":"M", "riskScoreThresholdName":"Medium" }, { "color":"D80202", "lower":60, "upper":80, "level":4, "riskScoreThresholdCode":"H", "riskScoreThresholdName":"High" }, { "color":"A20202", "lower":80, "upper":100, "level":5, "riskScoreThresholdCode":"VH", "riskScoreThresholdName":"Very High" } ] }, "valueSetFlag":true }, "Create_a_User_Risk_Score_Type_Using_Workspace_Code":{ "summary":"Create a User Risk Score Type Using Workspace Code", "description":"Payload to create risk score type using the workspace ID, score type, risk score type name, and risk score thresholds such as color, level, string value, risk score threshold code, and name.", "value":{ "riskScoreTypeName":"Safety Threshold (5 level)", "workspaceCode":"Ananth Constructions", "scoreType":"USER", "riskScoreThresholds":[ { "color":"bdbdbd", "level":0, "riskScoreThresholdCode":"N", "riskScoreThresholdName":"Negligible" }, { "color":"00857C", "level":1, "riskScoreThresholdCode":"VL", "riskScoreThresholdName":"Very Low", "stringValue":"light Injury / First Aid" }, { "color":"008000", "level":2, "riskScoreThresholdCode":"L", "riskScoreThresholdName":"Low", "stringValue":"Minor Injury" }, { "color":"F9AA01", "level":3, "riskScoreThresholdCode":"M", "riskScoreThresholdName":"Medium", "stringValue":"Mijor Injury" }, { "color":"D80202", "level":4, "riskScoreThresholdCode":"H", "riskScoreThresholdName":"High", "stringValue":"1 to 3 fatalities or PTDs" }, { "color":"A20202", "level":5, "riskScoreThresholdCode":"VH", "riskScoreThresholdName":"Very High", "stringValue":"Multiple (more than 3) fatalities or PTDs" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskScoreType", "$ref":"#/components/schemas/ApiEntityRiskScoreType", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-post", "x-filename-id":"riskscoretype-post" } }, "/riskScoreType/batch":{ "put":{ "tags":[ "Risk Score Type" ], "summary":"Batch Update Risk Score Types", "description":"Send a request to this endpoint to update one or more risk score types.", "operationId":"/riskScoreType/batch_updateBatch_48", "requestBody":{ "description":"One or more risk score type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Risk_Score_Types_Using_Risk_Score_Type_IDs":{ "summary":"Batch Update Risk Score Types Using Risk Score Type IDs", "description":"Payload to update the color in the risk threshold of one or more risk score types using the risk score type IDs and level.", "value":[ { "riskScoreTypeId":302106, "riskScoreThresholds":[ { "level":5, "color":"d72222" } ] }, { "riskScoreTypeId":302107, "riskScoreThresholds":[ { "level":5, "color":"d72222" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"riskScoreType-batch-put", "x-filename-id":"riskscoretype-batch-put" }, "post":{ "tags":[ "Risk Score Type" ], "summary":"Batch Create Risk Score Types", "description":"Send a request to this endpoint to create one or more risk score types.", "operationId":"/riskScoreType/batch_createBatch_50", "requestBody":{ "description":"One or more risk score type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Risk_Score_Types":{ "summary":"Batch Create Risk Score Types", "description":"Payload to create one or more risk score types using the workspace IDs, score types, and risk score type names.", "value":[ { "riskScoreTypeName":"Maintenance Probability", "workspaceId":726701, "scoreType":"PROBABILITY" }, { "riskScoreTypeName":"Maintenance Cost Impact", "workspaceId":726701, "scoreType":"COST" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-batch-post", "x-filename-id":"riskscoretype-batch-post" } }, "/riskScoreType/{riskScoreTypeId}":{ "get":{ "tags":[ "Risk Score Type" ], "summary":"View a Risk Score Type", "description":"This endpoint returns risk score types that meet the following requirements:
    • The object has an ID that matches the value of the {riskScoreTypeId} path parameter.
    ", "operationId":"/riskScoreType/{riskScoreTypeId}_find_70", "parameters":[ { "name":"riskScoreTypeId", "in":"path", "description":"The system-generated identifier of a risk score type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk score type does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskScoreType", "$ref":"#/components/schemas/ApiEntityRiskScoreType", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-{riskScoreTypeId}-get", "x-filename-id":"riskscoretype-riskscoretypeid-get" }, "delete":{ "tags":[ "Risk Score Type" ], "summary":"Delete a Risk Score Type", "description":"Send a request to this endpoint to delete a risk score type. The application object with an ID value that matches the value of the {riskScoreTypeId} path parameter will be deleted.", "operationId":"/riskScoreType/{riskScoreTypeId}_delete_52", "parameters":[ { "name":"riskScoreTypeId", "in":"path", "description":"The system-generated identifier of a risk score type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskScoreType-{riskScoreTypeId}-delete", "x-filename-id":"riskscoretype-riskscoretypeid-delete" } }, "/riskScoreType/name/{riskScoreTypeName}":{ "get":{ "tags":[ "Risk Score Type" ], "summary":"View a Risk Score Type by Name", "description":"This endpoint returns risk score types that meet the following requirements:
    • The object has a name that matches the value of the {riskScoreTypeName} path parameter.
    ", "operationId":"/riskScoreType/name/{riskScoreTypeName}_findByName_12", "parameters":[ { "name":"riskScoreTypeName", "in":"path", "description":"The name of a risk score type.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk score type does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-name-{riskScoreTypeName}-get", "x-filename-id":"riskscoretype-name-riskscoretypename-get" } }, "/riskScoreType/name/{riskScoreTypeName}/project/{projectId}":{ "get":{ "tags":[ "Risk Score Type" ], "summary":"View a Risk Score Type by Name and Project", "description":"This endpoint returns risk score types that meet the following requirements:
    • The object has a name that matches the value of the {riskScoreTypeName} path parameter.
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    ", "operationId":"/riskScoreType/name/{riskScoreTypeName}/project/{projectId}_findByNameAndProjectId", "parameters":[ { "name":"riskScoreTypeName", "in":"path", "description":"The name of a risk score type.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk score type does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskScoreType", "$ref":"#/components/schemas/ApiEntityRiskScoreType", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-name-{riskScoreTypeName}-project-{projectId}-get", "x-filename-id":"riskscoretype-name-riskscoretypename-project-projectid-get" } }, "/riskScoreType/workspace/{workspaceId}/name/{riskScoreTypeName}":{ "get":{ "tags":[ "Risk Score Type" ], "summary":"View a Risk Score Type by Name and Workspace", "description":"This endpoint returns risk score types that meet the following requirements:
    • The object has a name that matches the value of the {riskScoreTypeName} path parameter.
    • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
    ", "operationId":"/riskScoreType/workspace/{workspaceId}/name/{riskScoreTypeName}_findByNameAndWorkspace_2", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"riskScoreTypeName", "in":"path", "description":"The name of a risk score type.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested risk score type does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskScoreType", "$ref":"#/components/schemas/ApiEntityRiskScoreType", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-workspace-{workspaceId}-name-{riskScoreTypeName}-get", "x-filename-id":"riskscoretype-workspace-workspaceid-name-riskscoretypename-get" } }, "/riskScoreType/threshold/{riskScoreTypeId}":{ "get":{ "tags":[ "Risk Score Type" ], "summary":"View Risk Score Thresholds by Risk Score Type", "description":"This endpoint returns risk score thresholds that meet the following requirements:
    • The object is associated with a risk score type with an ID value that matches the value of the {riskScoreTypeId} path parameter.
    ", "operationId":"/riskScoreType/threshold/{riskScoreTypeId}_findThresholdByCode", "parameters":[ { "name":"riskScoreTypeId", "in":"path", "description":"The system-generated identifier of a risk score type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk score type does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreThreshold", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-threshold-{riskScoreTypeId}-get", "x-filename-id":"riskscoretype-threshold-riskscoretypeid-get" } }, "/riskScoreType/workspace/{workspaceId}":{ "get":{ "tags":[ "Risk Score Type" ], "summary":"View all Risk Score Types by Workspace", "description":"This endpoint returns risk score types that meet the following requirements:
    • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
    ", "operationId":"/riskScoreType/workspace/{workspaceId}_getResourcesAndRolesByWorkspace_1", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested risk score type does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-workspace-{workspaceId}-get", "x-filename-id":"riskscoretype-workspace-workspaceid-get" } }, "/riskScoreType/program/{programId}":{ "get":{ "tags":[ "Risk Score Type" ], "summary":"View Risk Score Types by Program", "description":"This endpoint returns risk score types that are associated with a program ID value that matches the value of the {programId} path parameter.", "operationId":"/riskScoreType/program/{programId}_getRiskScoreTypeByProgram", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated unique identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-program-{programId}-get", "x-filename-id":"riskscoretype-program-programid-get" } }, "/riskScoreType/project/{projectId}":{ "get":{ "tags":[ "Risk Score Type" ], "summary":"View Risk Score Types by Project", "description":"This endpoint returns risk score types that are associated with a project ID value that matches the value of the {projectId} path parameter.", "operationId":"/riskScoreType/project/{projectId}_getRiskScoreTypeByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-project-{projectId}-get", "x-filename-id":"riskscoretype-project-projectid-get" } }, "/riskScoreType/syncBatch":{ "post":{ "tags":[ "Risk Score Type" ], "summary":"Batch Sync Risk Score Types", "description":"Send a request to this endpoint to create or update one or more risk score types.", "operationId":"/riskScoreType/syncBatch_syncBatch_51", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any risk score type sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more risk score type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Risk_Score_Types_Using_Workspace_Code":{ "summary":"Batch Create or Update Risk Score Types Using Workspace Code", "description":"Payload to create or update one or more risk score types using the workspace code, score type, and risk score type name.", "value":[ { "riskScoreTypeName":"Maintenance Probability", "workspaceCode":"Ananth Construction", "scoreType":"PROBABILITY" } ], "valueSetFlag":true }, "Sync Risk Score Types":{ "summary":"Sync Risk Score Types", "description":"Payload to create or update one or more risk score types (thresholds) using the workspace IDs, score types, risk score type names.", "value":[ { "riskScoreTypeName":"Cordova Cost Threshold", "workspaceId":726701, "scoreType":"COST" }, { "riskScoreTypeName":"Cordova Schedule Threshold", "workspaceId":726701, "scoreType":"SCHEDULE" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskScoreType-syncBatch-post", "x-filename-id":"riskscoretype-syncbatch-post" } }, "/riskWeatherPeriod":{ "put":{ "tags":[ "Project Risk Weather Period" ], "summary":"Update a Project Risk Weather Period", "description":"Send a request to this endpoint to update a project risk weather period.", "operationId":"/riskWeatherPeriod_update_52", "requestBody":{ "description":"A risk weather period object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskWeatherPeriodInput", "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriodInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Risk_Weather_Period_Using_Project_Risk_Weather_Period_ID":{ "summary":"Update a Project Risk Weather Period Using Project Risk Weather Period ID", "description":"Payload to update the maximum, minimum, and the most probable number of nonworking days using the project risk weather period ID.", "value":{ "riskWeatherPeriodId":64102, "maxNonWorkingDays":21, "minNonWorkingDays":6, "mostLikelyNonWorkingDays":15 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskWeatherPeriod-put", "x-filename-id":"riskweatherperiod-put" }, "post":{ "tags":[ "Project Risk Weather Period" ], "summary":"Create a Project Risk Weather Period", "description":"Send a request to this endpoint to create a project risk weather period.", "operationId":"/riskWeatherPeriod_create_55", "requestBody":{ "description":"A risk weather period object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskWeatherPeriodInput", "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriodInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Risk_Weather_Period":{ "summary":"Create a Project Risk Weather Period", "description":"Payload to create a project risk weather period using the project risk ID, period name, period start and finish dates, nonworking time definition type, maximum, and minimum nonworking days, and the most probable number of nonworking days, and shape.", "value":{ "projectRiskId":72101, "periodName":"2021-2022 Winter Inclement Weather", "periodStart":"2023-01-03T00:00:00", "periodFinish":"2023-02-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":18, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":15, "shape":"TRIANGLE" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskWeatherPeriod", "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriod", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskWeatherPeriod-post", "x-filename-id":"riskweatherperiod-post" } }, "/riskWeatherPeriod/batch":{ "put":{ "tags":[ "Project Risk Weather Period" ], "summary":"Batch Update Project Risk Weather Periods", "description":"Send a request to this endpoint to update one or more project risk weather periods.", "operationId":"/riskWeatherPeriod/batch_updateBatch_49", "requestBody":{ "description":"A risk weather period object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriodInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Risk_Weather_Periods_Using_Project_Risk_Weather_Period_IDs":{ "summary":"Batch Update Project Risk Weather Periods Using Project Risk Weather Period IDs", "description":"Payload to update the maximum, minimum and the most probable number of nonworking days for one or more project risk weather periods using the risk weather period IDs.", "value":[ { "riskWeatherPeriodId":64101, "maxNonWorkingDays":28, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":10 }, { "riskWeatherPeriodId":64102, "maxNonWorkingDays":20, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":10 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"riskWeatherPeriod-batch-put", "x-filename-id":"riskweatherperiod-batch-put" }, "post":{ "tags":[ "Project Risk Weather Period" ], "summary":"Batch Create Project Risk Weather Periods", "description":"Send a request to this endpoint to create one or more project risk weather periods.", "operationId":"/riskWeatherPeriod/batch_createBatch_51", "requestBody":{ "description":"One or more risk weather period objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriodInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Risk_Weather_Periods":{ "summary":"Batch Create Project Risk Weather Periods", "description":"Payload to create one or more project risk weather periods using the project risk IDs, period names, period start and finish dates, nonworking time definition types, maximum, and minimum nonworking days, and the most probable number of nonworking days, and shapes.", "value":[ { "projectRiskId":72101, "periodName":"2021-2022 Winter Inclement Weather", "periodStart":"2022-01-03T00:00:00", "periodFinish":"2022-02-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":18, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":15, "shape":"TRIANGLE" }, { "projectRiskId":72101, "periodName":"2022-2023 Winter Inclement Weather", "periodStart":"2022-12-13T00:00:00", "periodFinish":"2023-02-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":20, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":10, "shape":"TRIANGLE" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskWeatherPeriod-batch-post", "x-filename-id":"riskweatherperiod-batch-post" }, "delete":{ "tags":[ "Project Risk Weather Period" ], "summary":"Batch Delete Project Risk Weather Periods", "description":"Send a request to this endpoint to delete one or more project risk weather periods.", "operationId":"/riskWeatherPeriod/batch_deleteBatch_49", "requestBody":{ "description":"The system-generated identifier of a risk weather period.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskWeatherPeriod-batch-delete", "x-filename-id":"riskweatherperiod-batch-delete" } }, "/riskWeatherPeriod/{riskWeatherPeriodId}":{ "get":{ "tags":[ "Project Risk Weather Period" ], "summary":"View a Project Risk Weather Period", "description":"This endpoint returns project risk weather periods that meet the following requirements:
    • The object has an ID that matches the value of the {riskWeatherPeriodId} path parameter.
    ", "operationId":"/riskWeatherPeriod/{riskWeatherPeriodId}_find_71", "parameters":[ { "name":"riskWeatherPeriodId", "in":"path", "description":"The system-generated identifier of a risk weather period.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project risk weather period does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRiskWeatherPeriod", "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriod", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"riskWeatherPeriod-{riskWeatherPeriodId}-get", "x-filename-id":"riskweatherperiod-riskweatherperiodid-get" }, "delete":{ "tags":[ "Project Risk Weather Period" ], "summary":"Delete a Project Risk Weather Period", "description":"Send a request to this endpoint to delete a project risk weather period. The application object with an ID value that matches the value of the {riskWeatherPeriodId} path parameter will be deleted.", "operationId":"/riskWeatherPeriod/{riskWeatherPeriodId}_delete_53", "parameters":[ { "name":"riskWeatherPeriodId", "in":"path", "description":"The system-generated identifier of a risk weather period.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"riskWeatherPeriod-{riskWeatherPeriodId}-delete", "x-filename-id":"riskweatherperiod-riskweatherperiodid-delete" } }, "/riskWeatherPeriod/code/{periodName}":{ "get":{ "tags":[ "Project Risk Weather Period" ], "summary":"View all Project Risk Weather Periods by Period Name", "description":"This endpoint returns project risk weather periods that meet the following requirements:
    • The object has a name that matches the value of the {periodName} path parameter.
    ", "operationId":"/riskWeatherPeriod/code/{periodName}_findByCode_14", "parameters":[ { "name":"periodName", "in":"path", "description":"The user-specified identifier of a risk weather period.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project risk weather period does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskWeatherPeriod-code-{periodName}-get", "x-filename-id":"riskweatherperiod-code-periodname-get" } }, "/riskWeatherPeriod/project/{projectId}":{ "get":{ "tags":[ "Project Risk Weather Period" ], "summary":"View all Project Risk Weather Periods by Project ID", "description":"This endpoint returns project risk weather periods that meet the following requirements:
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    ", "operationId":"/riskWeatherPeriod/project/{projectId}_findByProjectId_6", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"The requested project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskWeatherPeriod-project-{projectId}-get", "x-filename-id":"riskweatherperiod-project-projectid-get" } }, "/riskWeatherPeriod/syncBatch":{ "post":{ "tags":[ "Project Risk Weather Period" ], "summary":"Batch Sync Project Risk Weather Periods", "description":"Send a request to this endpoint to create or update one or more project risk weather periods.", "operationId":"/riskWeatherPeriod/syncBatch_syncBatch_52", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any project risk weather period sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more risk weather period objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskWeatherPeriodInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Risk_Weather_Periods_Using_Project_ID":{ "summary":"Batch Create or Update Risk Weather Periods Using Project ID", "description":"Payload to create or update one or more project risk weather periods using the project ID, risk code, period name, period start and finish dates, nonworking time definition type, maximum and minimum nonworking days, the most probable number of nonworking days, and shape.", "value":[ { "projectId":72101, "riskCode":"R01", "periodName":"2021-2022 Winter Inclement Weather", "periodStart":"2023-01-03T00:00:00", "periodFinish":"2023-02-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":18, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":15, "shape":"TRIANGLE" } ], "valueSetFlag":true }, "Batch_Create_or_Update_Risk_Weather_Periods_Using_Codes":{ "summary":"Batch Create or Update Risk Weather Periods Using Codes", "description":"Payload to create or update one or more project risk weather periods using the workspace code, project code, risk code, period name, period start and finish dates, nonworking time definition type, maximum and minimum nonworking days, the most probable number of nonworking days, and shape.", "value":[ { "workspaceCode":"Ananth Construction", "projectCode":"ATP", "riskCode":"R01", "periodName":"2021-2022 Winter Inclement Weather", "periodStart":"2023-01-03T00:00:00", "periodFinish":"2023-02-28T00:00:00", "nonWorkingTimeDefinitionType":"DISTRIBUTION", "maxNonWorkingDays":18, "minNonWorkingDays":5, "mostLikelyNonWorkingDays":15, "shape":"TRIANGLE" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"riskWeatherPeriod-syncBatch-post", "x-filename-id":"riskweatherperiod-syncbatch-post" } }, "/ruleOfCredit":{ "put":{ "tags":[ "Rule Of Credit" ], "summary":"Update a Rule of Credit", "description":"Send a request to this endpoint to update a rule of credit. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/ruleOfCredit_update_53", "requestBody":{ "description":"A rule of credit object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRuleOfCreditInput", "$ref":"#/components/schemas/ApiEntityRuleOfCreditInput", "exampleSetFlag":false }, "examples":{ "Update_a_Rule_of_Credit_Using_Rule_of_Credit_ID":{ "summary":"Update a Rule of Credit Using Rule of Credit ID", "description":"Payload to update the milestones by adjusting the percentage complete to 100 using the rule of credit ID.", "value":{ "rocId":10005, "milestones":[ { "sequenceNumber":10, "percentComplete":0.1, "milestoneName":"Material at site" }, { "sequenceNumber":10, "percentComplete":0.3, "milestoneName":"pipe laying" }, { "sequenceNumber":10, "percentComplete":0.3, "milestoneName":"Full welding Execution" }, { "sequenceNumber":10, "percentComplete":0.2, "milestoneName":"Pipe support erection" }, { "sequenceNumber":10, "percentComplete":0.1, "milestoneName":"Final inspection" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the rule of credit service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"ruleOfCredit-put", "x-filename-id":"ruleofcredit-put" }, "post":{ "tags":[ "Rule Of Credit" ], "summary":"Create a Rule of Credit", "description":"Send a request to this endpoint to create a rule of credit. An application object will be created using the JSON data provided in the request body.", "operationId":"/ruleOfCredit_create_56", "requestBody":{ "description":"A rule of credit object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRuleOfCreditInput", "$ref":"#/components/schemas/ApiEntityRuleOfCreditInput", "exampleSetFlag":false }, "examples":{ "Create_a_Rule_of_Credit":{ "summary":"Create a Rule of Credit", "description":"Payload to create rules of credit using the type, workspace ID, rule of credit name, and milestones such as sequence number, percentage complete, and milestone name.", "value":{ "type":"ZERO_TO_ONE_HUNDRED", "workspaceId":726701, "rocName":"Piping Erection", "milestones":[ { "sequenceNumber":10, "percentComplete":0.1, "milestoneName":"Material at site" }, { "sequenceNumber":10, "percentComplete":0.4, "milestoneName":"pipe laying" }, { "sequenceNumber":10, "percentComplete":0.5, "milestoneName":"Full welding Execution" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the rule of credit service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRuleOfCredit", "$ref":"#/components/schemas/ApiEntityRuleOfCredit", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"ruleOfCredit-post", "x-filename-id":"ruleofcredit-post" } }, "/ruleOfCredit/batch":{ "put":{ "tags":[ "Rule Of Credit" ], "summary":"Batch Update Rules of Credit", "description":"Send a request to this endpoint to update one or more rules of credit. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/ruleOfCredit/batch_updateBatch_50", "requestBody":{ "description":"One or more rule of credit objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCreditInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Rules_of_Credits_Using_Rule_of_Credit_IDs.":{ "summary":"Batch Update Rules of Credits Using Rule of Credit IDs.", "description":"Payload to update the milestones of one or more rules of credit by adjusting the percentage completes to 100 using the rule of credit IDs.", "value":[ { "rocId":10005, "milestones":[ { "sequenceNumber":10, "percentComplete":0.1, "milestoneName":"Material at site" }, { "sequenceNumber":10, "percentComplete":0.3, "milestoneName":"pipe laying" }, { "sequenceNumber":10, "percentComplete":0.3, "milestoneName":"Full welding Execution" }, { "sequenceNumber":10, "percentComplete":0.2, "milestoneName":"Pipe support erection" }, { "sequenceNumber":10, "percentComplete":0.1, "milestoneName":"Final inspection" } ] }, { "rocId":10006, "milestones":[ { "sequenceNumber":10, "percentComplete":0.2, "milestoneName":"Transportation to site" }, { "sequenceNumber":10, "percentComplete":0.3, "milestoneName":"Tray erection" }, { "sequenceNumber":10, "percentComplete":0.4, "milestoneName":"cable laying" }, { "sequenceNumber":10, "percentComplete":0.1, "milestoneName":"cable connection & testing" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the rule of credit service. Verify the request contains valid data, then resubmit the request." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"ruleOfCredit-batch-put", "x-filename-id":"ruleofcredit-batch-put" }, "post":{ "tags":[ "Rule Of Credit" ], "summary":"Batch Create Rules of Credit", "description":"Send a request to this endpoint to create one or more rules of credit. An application object will be created for each JSON object provided in the request body.", "operationId":"/ruleOfCredit/batch_createBatch_52", "requestBody":{ "description":"One or more rule of credit objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCreditInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Rules_of_Credit":{ "summary":"Batch Create Rules of Credit", "description":"Payload to create rules of credit using the type, workspace ID, rule of credit name, and milestones such as sequence number, percentage complete, and milestone name.", "value":[ { "type":"ZERO_TO_ONE_HUNDRED", "workspaceId":726701, "rocName":"Piping Erection", "milestones":[ { "sequenceNumber":10, "percentComplete":0.1, "milestoneName":"Material at site" }, { "sequenceNumber":10, "percentComplete":0.4, "milestoneName":"pipe laying" }, { "sequenceNumber":10, "percentComplete":0.5, "milestoneName":"Full welding Execution" } ] }, { "type":"ZERO_TO_ONE_HUNDRED", "workspaceId":726701, "rocName":"Electrical cabling", "milestones":[ { "sequenceNumber":10, "percentComplete":0.2, "milestoneName":"Transportation to site" }, { "sequenceNumber":10, "percentComplete":0.3, "milestoneName":"Tray erection" }, { "sequenceNumber":10, "percentComplete":0.5, "milestoneName":"cable laying" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the rule of credit service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCredit", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"ruleOfCredit-batch-post", "x-filename-id":"ruleofcredit-batch-post" }, "delete":{ "tags":[ "Rule Of Credit" ], "summary":"Batch Delete Rules of Credit", "description":"Send a request to this endpoint to delete one or more rules of credit. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/ruleOfCredit/batch_deleteBatch_50", "requestBody":{ "description":"One or more system-generated identifiers of rules of credit.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the rule of credit service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"ruleOfCredit-batch-delete", "x-filename-id":"ruleofcredit-batch-delete" } }, "/ruleOfCredit/{rocId}":{ "get":{ "tags":[ "Rule Of Credit" ], "summary":"View a Rule of Credit", "description":"This endpoint returns rules of credit that meet the following requirements:
    • The object is associated with a rule of credit with an ID value that matches the value of the {rocId} path parameter.
    Rules of credit can be used when tracking progress on scope assignments in work packages.", "operationId":"/ruleOfCredit/{rocId}_find_72", "parameters":[ { "name":"rocId", "in":"path", "description":"The system-generated identifier of a rule of credit.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested rule of credit does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRuleOfCredit", "$ref":"#/components/schemas/ApiEntityRuleOfCredit", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"ruleOfCredit-{rocId}-get", "x-filename-id":"ruleofcredit-rocid-get" }, "delete":{ "tags":[ "Rule Of Credit" ], "summary":"Delete a Rule of Credit", "description":"Send a request to this endpoint to delete a rule of credit. The application object with an ID value that matches the value of the {rocId} path parameter will be deleted.", "operationId":"/ruleOfCredit/{rocId}_delete_54", "parameters":[ { "name":"rocId", "in":"path", "description":"The system-generated identifier of a rule of credit.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the rule of credit service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"ruleOfCredit-{rocId}-delete", "x-filename-id":"ruleofcredit-rocid-delete" } }, "/ruleOfCredit/name/{rocName}":{ "get":{ "tags":[ "Rule Of Credit" ], "summary":"View Rules of Credit by Name", "description":"This endpoint returns rules of credit that meet the following requirements:
    • The object has a name that matches the value of the {rocName} path parameter.
    Rules of credit can be used when tracking progress on scope assignments in work packages.", "operationId":"/ruleOfCredit/name/{rocName}_findByName_13", "parameters":[ { "name":"rocName", "in":"path", "description":"The name of the rule of credit.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested rule of credit does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCredit", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"ruleOfCredit-name-{rocName}-get", "x-filename-id":"ruleofcredit-name-rocname-get" } }, "/ruleOfCredit/ROCMilestone/{rocId}":{ "get":{ "tags":[ "Rule Of Credit" ], "summary":"View Rule of Credit Milestones", "description":"This endpoint returns rule of credit milestones that meet the following requirements:
    • The object is associated with a rule of credit with an ID value that matches the value of the {rocId} path parameter.
    ", "operationId":"/ruleOfCredit/ROCMilestone/{rocId}_findMilestones", "parameters":[ { "name":"rocId", "in":"path", "description":"The system-generated identifier of a rule of credit.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested rule of credit milestone does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestone", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"ruleOfCredit-ROCMilestone-{rocId}-get", "x-filename-id":"ruleofcredit-rocmilestone-rocid-get" } }, "/ruleOfCredit/workspace/{workspaceId}":{ "get":{ "tags":[ "Rule Of Credit" ], "summary":"View Rules of Credit by Workspace", "description":"This endpoint returns rules of credit that meet the following requirements:
    • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
    Rules of credit can be used when tracking progress on scope assignments in work packages.", "operationId":"/ruleOfCredit/workspace/{workspaceId}_getRuleOfCreditByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested rule of credit does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCredit", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"ruleOfCredit-workspace-{workspaceId}-get", "x-filename-id":"ruleofcredit-workspace-workspaceid-get" } }, "/ruleOfCredit/workspace/code/{workspaceCode}":{ "get":{ "tags":[ "Rule Of Credit" ], "summary":"View Rules of Credit by Workspace Code", "description":"This endpoint returns rules of credit that meet the following requirements:
    • The object is associated with a workspace with a code value that matches the value of the {workspaceCode} path parameter.
    Rules of credit can be used when tracking progress on scope assignments in work packages.", "operationId":"/ruleOfCredit/workspace/code/{workspaceCode}_getRuleOfCreditByWorkspaceCode", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested rule of credit does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCredit", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"ruleOfCredit-workspace-code-{workspaceCode}-get", "x-filename-id":"ruleofcredit-workspace-code-workspacecode-get" } }, "/ruleOfCredit/syncBatch":{ "post":{ "tags":[ "Rule Of Credit" ], "summary":"Batch Sync Rules of Credit", "description":"Send a request to this endpoint to create or update one or more Rules of Credit.", "operationId":"/ruleOfCredit/syncBatch_syncBatch_53", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any rules of credit sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more Rules of Credit", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCreditInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Rules_of_Credit_Using_Workspace_ID":{ "summary":"Create or Update Rules of Credit Using Workspace ID", "description":"Payload to create or update the rules of credit using the type, workspace ID, rule of credit name, and milestones such as sequence number, percentage complete, and milestone name.", "value":[ { "type":"ZERO_TO_ONE_HUNDRED", "workspaceId":726701, "rocName":"Piping Erection", "milestones":[ { "sequenceNumber":10, "percentComplete":0.1, "milestoneName":"Material at the site" }, { "sequenceNumber":10, "percentComplete":0.4, "milestoneName":"pipe laying" }, { "sequenceNumber":10, "percentComplete":0.5, "milestoneName":"Full welding Execution" } ] } ], "valueSetFlag":true }, "Create_or_Update_Rules_of_Credit_Using_Workspace_Code":{ "summary":"Create or Update Rules of Credit Using Workspace Code", "description":"Payload to create or update the rules of credit using the type, workspace code, rule of credit name, and milestones such as sequence number, percentage complete, and milestone name.", "value":[ { "type":"ZERO_TO_ONE_HUNDRED", "workspaceCode":"North America", "rocName":"Piping Erection", "milestones":[ { "sequenceNumber":10, "percentComplete":0.1, "milestoneName":"Material at the site" }, { "sequenceNumber":10, "percentComplete":0.4, "milestoneName":"pipe laying" }, { "sequenceNumber":10, "percentComplete":0.5, "milestoneName":"Full welding Execution" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"ruleOfCredit-syncBatch-post", "x-filename-id":"ruleofcredit-syncbatch-post" } }, "/scheduleScenario":{ "get":{ "tags":[ "Schedule Scenario" ], "summary":"View a Schedule Scenario By Name", "description":"Send a request to this endpoint to view the schedule scenario by its name.", "operationId":"/scheduleScenario_findByName_14", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"name", "in":"query", "description":"The user-specified unique identifier of a schedule scenario.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleScenario", "$ref":"#/components/schemas/ApiEntityScheduleScenario", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scheduleScenario-get", "x-filename-id":"schedulescenario-get" }, "put":{ "tags":[ "Schedule Scenario" ], "summary":"Update a Schedule Scenario", "description":"Send a request to this endpoint to update a schedule scenario.", "operationId":"/scheduleScenario_update_54", "requestBody":{ "description":"A schedule scenario object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleScenarioInput", "$ref":"#/components/schemas/ApiEntityScheduleScenarioInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Schedule Scenario service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"scheduleScenario-put", "x-filename-id":"schedulescenario-put" }, "post":{ "tags":[ "Schedule Scenario" ], "summary":"Create a Schedule Scenario", "description":"Send a request to this endpoint to create a schedule scenario.", "operationId":"/scheduleScenario_create_57", "requestBody":{ "description":"A schedule scenario object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleScenarioInput", "$ref":"#/components/schemas/ApiEntityScheduleScenarioInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Schedule Scenario service. Verify the request contains valid data, then resubmit the request." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleScenario", "$ref":"#/components/schemas/ApiEntityScheduleScenario", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scheduleScenario-post", "x-filename-id":"schedulescenario-post" }, "delete":{ "tags":[ "Schedule Scenario" ], "summary":"Delete a Schedule Scenario By Name", "description":"Send a request to this endpoint to delete a schedule scenario by providing query parameters for the scenario.", "operationId":"/scheduleScenario_deleteScenarioByName", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"name", "in":"query", "description":"The user-specified unique identifier of a schedule scenario.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"scheduleScenario-delete", "x-filename-id":"schedulescenario-delete" } }, "/scheduleScenario/{scenarioId}":{ "get":{ "tags":[ "Schedule Scenario" ], "summary":"View a Schedule Scenario", "description":"This endpoint returns schedule scenario that meet the following requirements:
    • The object has a ID that matches the value of the {scenarioId} path parameter.
    ", "operationId":"/scheduleScenario/{scenarioId}_find_73", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated unique identifier of a schedule scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested schedule scenario does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleScenario", "$ref":"#/components/schemas/ApiEntityScheduleScenario", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scheduleScenario-{scenarioId}-get", "x-filename-id":"schedulescenario-scenarioid-get" }, "delete":{ "tags":[ "Schedule Scenario" ], "summary":"Delete a Schedule Scenario", "description":"Send a request to this endpoint to delete a schedule scenario. The application object with an ID value that matches the value of the {scenarioId} path parameter will be deleted.", "operationId":"/scheduleScenario/{scenarioId}_delete_55", "parameters":[ { "name":"scenarioId", "in":"path", "description":"The system-generated unique identifier of a schedule scenario.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Schedule Scenario service. Verify the request contains valid data, then resubmit the request." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"scheduleScenario-{scenarioId}-delete", "x-filename-id":"schedulescenario-scenarioid-delete" } }, "/scheduleScenario/parent":{ "get":{ "tags":[ "Schedule Scenario" ], "summary":"View Schedule Scenarios By Parent Code ", "description":"Send a request to this endpoint to view all the schedule scenarios under the project using the set of parent codes as query parameters.", "operationId":"/scheduleScenario/parent_findScenarioByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScheduleScenario", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scheduleScenario-parent-get", "x-filename-id":"schedulescenario-parent-get" } }, "/scheduleScenario/project/{projectId}":{ "get":{ "tags":[ "Schedule Scenario" ], "summary":"View Schedule Scenarios By Project ", "description":"Send a request to this endpoint to view all the schedule scenarios under the project.", "operationId":"/scheduleScenario/project/{projectId}_findScenarioByProjectId", "parameters":[ { "name":"projectId", "in":"path", "description":"The user-specified identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScheduleScenario", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scheduleScenario-project-{projectId}-get", "x-filename-id":"schedulescenario-project-projectid-get" } }, "/actualsTimePhasedData":{ "put":{ "tags":[ "Scope Assignment Actuals Time Phased Data" ], "summary":"Update Scope Assignment Actuals Time Phased Data ", "description":"Send a request to this endpoint to update scope assignment actual time phased data.", "operationId":"/actualsTimePhasedData_update_55", "requestBody":{ "description":"An actual time phased data object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentActualsTimePhasedDataInput", "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedDataInput", "exampleSetFlag":false }, "examples":{ "Update_Scope_Assignment_Actuals_Time_Phased_Data":{ "summary":"Update Scope Assignment Actuals Time Phased Data", "description":"Payload to update actual cost project using the scope assignment actual time-phased data ID.", "value":{ "scopeAssignmentActualsTimePhasedDataId":14001, "scopeAssignmentActualsTimePhasedCostData":{ "scopeAssignmentActualsTimePhasedDataId":14001, "actualsCostProject":960 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Actuals Time Phased Data Service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"actualsTimePhasedData-put", "x-filename-id":"actualstimephaseddata-put" }, "post":{ "tags":[ "Scope Assignment Actuals Time Phased Data" ], "summary":"Create Scope Assignment Actuals Time Phased Data", "description":"Send a request to this endpoint to create scope assignment actual time phased data.", "operationId":"/actualsTimePhasedData_create_58", "requestBody":{ "description":"An actual time phased data object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentActualsTimePhasedDataInput", "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedDataInput", "exampleSetFlag":false }, "examples":{ "Create_Scope_Assignment_Actuals_Time_Phased_Data":{ "summary":"Create Scope Assignment Actuals Time Phased Data", "description":"Payload to create scope assignment actual time-phased data using the scope assignment ID, date, and scope assignment actual time phase cost data.", "value":{ "scopeItemAssignmentId":32001, "date":"2023-03-24T23:02:15", "scopeAssignmentActualsTimePhasedCostData":{ "actualsCostProject":900 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Actuals Time Phased Data Service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentActualsTimePhasedData", "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedData", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"actualsTimePhasedData-post", "x-filename-id":"actualstimephaseddata-post" } }, "/actualsTimePhasedData/batch":{ "put":{ "tags":[ "Scope Assignment Actuals Time Phased Data" ], "summary":"Batch Update Scope Assignment Actuals Time Phased Data ", "description":"Send a request to this endpoint to update one or more scope assignment actual time phased data.", "operationId":"/actualsTimePhasedData/batch_updateBatch_51", "requestBody":{ "description":"One or more actual time phased data objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Scope_Assignment_Actuals_Time_Phased_Data":{ "summary":"Batch Update Scope Assignment Actuals Time Phased Data", "description":"Payload to update one or more dates using the scope assignment actual time-phased data IDs.", "value":[ { "scopeAssignmentActualsTimePhasedDataId":14002, "date":"2023-03-25T23:02:15" }, { "scopeAssignmentActualsTimePhasedDataId":14003, "date":"2023-03-25T23:02:15" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Actuals Time Phased Data Service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"actualsTimePhasedData-batch-put", "x-filename-id":"actualstimephaseddata-batch-put" }, "post":{ "tags":[ "Scope Assignment Actuals Time Phased Data" ], "summary":"Batch Create Scope Assignment Actuals Time Phased Data ", "description":"Send a request to this endpoint to create one or more scope assignment actual time phased data.", "operationId":"/actualsTimePhasedData/batch_createBatch_53", "requestBody":{ "description":"One or more actual time phased data objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Scope_Assignment_Actuals_Time_Phased_Data":{ "summary":"Batch Create Scope Assignment Actuals Time Phased Data", "description":"Payload to create one or more scope assignment actual time-phased data using scope assignment ID, date, and scope assignment actual time-phased cost data.", "value":[ { "scopeItemAssignmentId":32001, "date":"2023-03-24T23:02:15", "scopeAssignmentActualsTimePhasedCostData":{ "actualsCostProject":900 } }, { "scopeItemAssignmentId":32001, "date":"2023-03-24T23:02:15", "scopeAssignmentActualsTimePhasedCostData":{ "actualsCostProject":900 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Actuals Time Phased Data Service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedData", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"actualsTimePhasedData-batch-post", "x-filename-id":"actualstimephaseddata-batch-post" }, "delete":{ "tags":[ "Scope Assignment Actuals Time Phased Data" ], "summary":"Batch Delete Scope Assignment Actuals Time Phased Data ", "description":"Send a request to this endpoint to delete one or more scope assignment actual time phased data.", "operationId":"/actualsTimePhasedData/batch_deleteBatch_51", "requestBody":{ "description":"The system-generated identifier of actual time phased data.S", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Actuals Time Phased Data Service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"actualsTimePhasedData-batch-delete", "x-filename-id":"actualstimephaseddata-batch-delete" } }, "/actualsTimePhasedData/{scopeAssignmentActualsTimePhasedDataId}":{ "get":{ "tags":[ "Scope Assignment Actuals Time Phased Data" ], "summary":"View Scope Assignment Actuals Time Phased Data ", "description":"This endpoint returns scope assignment actual time phased data that meet the following requirements:
    • The object has an ID that matches the value of the {actualsTimePhasedDataId} path parameter.
    ", "operationId":"/actualsTimePhasedData/{scopeAssignmentActualsTimePhasedDataId}_find_74", "parameters":[ { "name":"scopeAssignmentActualsTimePhasedDataId", "in":"path", "description":"The system-generated identifier of actual time phased data.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope assignment actuals time phased data does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentActualsTimePhasedData", "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedData", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"actualsTimePhasedData-{scopeAssignmentActualsTimePhasedDataId}-get", "x-filename-id":"actualstimephaseddata-scopeassignmentactualstimephaseddataid-get" }, "delete":{ "tags":[ "Scope Assignment Actuals Time Phased Data" ], "summary":"Delete Scope Assignment Actuals Time Phased Data ", "description":"Send a request to this endpoint to delete scope assignment actual time phased data.", "operationId":"/actualsTimePhasedData/{scopeAssignmentActualsTimePhasedDataId}_delete_56", "parameters":[ { "name":"scopeAssignmentActualsTimePhasedDataId", "in":"path", "description":"The system-generated identifier of actual time phased data.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Scope Assignment Actuals Time Phased Data Service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"actualsTimePhasedData-{scopeAssignmentActualsTimePhasedDataId}-delete", "x-filename-id":"actualstimephaseddata-scopeassignmentactualstimephaseddataid-delete" } }, "/actualsTimePhasedData/scopeAssignment/{scopeItemAssignmentId}":{ "get":{ "tags":[ "Scope Assignment Actuals Time Phased Data" ], "summary":"View all Scope Assignment Actuals Time Phased Data by Scope Assignment ", "description":"This endpoint returns actual time phased data that meet the following requirements:
    • The object is associated with a scope assignment with an ID value that matches the value of the {scopeAssignmentId} path parameter.
    ", "operationId":"/actualsTimePhasedData/scopeAssignment/{scopeItemAssignmentId}_findByScopeAssignmentId", "parameters":[ { "name":"scopeItemAssignmentId", "in":"path", "description":"The system-generated identifier of a scope assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope assignment actuals time phased data does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedData", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"actualsTimePhasedData-scopeAssignment-{scopeItemAssignmentId}-get", "x-filename-id":"actualstimephaseddata-scopeassignment-scopeitemassignmentid-get" } }, "/actualsTimePhasedData/syncBatch":{ "post":{ "tags":[ "Scope Assignment Actuals Time Phased Data" ], "summary":"Batch Sync Scope Assignment Actuals Time Phased Data", "description":"Send a request to this endpoint to create or update one or more scope assignment actual time phased data.", "operationId":"/actualsTimePhasedData/syncBatch_syncBatch_54", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any scope assignment actuals time phased data record sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more scope assignment actuals time phased data objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Scope_Assignment_Actuals_Time_Phased_Data":{ "summary":"Batch Create or Update Scope Assignment Actuals Time Phased Data", "description":"Payload to create or update one or more scope assignment actual time phased data records using the scope item assignment code, work package code, project code, workspace code, scope item code, date, and scope assignment actual time phased cost data.", "value":[ { "scopeItemAssignCode":"SA10", "workPackageCode":"WP10", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "scopeItemCode":"SI01", "date":"2023-07-05T00:00:00", "scopeAssignmentActualsTimePhasedCostData":{ "actualsCostProject":40 } } ], "valueSetFlag":true }, "Batch_Create_or_Update_Scope_Assignment_Actuals_Time_Phased_Data_Using_ID":{ "summary":"Batch Create or Update Scope Assignment Actuals Time Phased Data Using ID", "description":"Payload to create or update one or more scope assignment actual time phased data records using the scope assignment ID, date, and scope assignment actual time phase cost data.", "value":[ { "scopeItemAssignmentId":32001, "date":"2023-05-24T23:02:15", "scopeAssignmentActualsTimePhasedCostData":{ "actualsCostProject":900 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"actualsTimePhasedData-syncBatch-post", "x-filename-id":"actualstimephaseddata-syncbatch-post" } }, "/baselineTimePhasedData/{scopeAssignmentBaselineTimePhasedDataId}":{ "get":{ "tags":[ "Scope Assignment Baseline Time Phased Data" ], "summary":"View Scope Assignment Baseline Time Phased Data", "description":"This endpoint returns baseline time phased data that meet the following requirements:
    • The object has an ID that matches the value of the {scopeAssignmentBaselineTimePhasedDataId} path parameter.
    ", "operationId":"/baselineTimePhasedData/{scopeAssignmentBaselineTimePhasedDataId}_find_75", "parameters":[ { "name":"scopeAssignmentBaselineTimePhasedDataId", "in":"path", "description":"The system-generated identifier of baseline time phased data.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope assignment baseline time phased data does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentBaselineTimePhasedData", "$ref":"#/components/schemas/ApiEntityScopeAssignmentBaselineTimePhasedData", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"baselineTimePhasedData-{scopeAssignmentBaselineTimePhasedDataId}-get", "x-filename-id":"baselinetimephaseddata-scopeassignmentbaselinetimephaseddataid-get" } }, "/baselineTimePhasedData/scopeAssignment/{scopeItemAssignmentId}":{ "get":{ "tags":[ "Scope Assignment Baseline Time Phased Data" ], "summary":"View all Scope Assignment Baseline Time Phased Data by Scope Assignment ", "description":"This endpoint returns baseline time phased data that meet the following requirements:
    • The object is associated with a scope item assignment with an ID value that matches the value of the {scopeItemAssigmentId} path parameter.
    ", "operationId":"/baselineTimePhasedData/scopeAssignment/{scopeItemAssignmentId}_findByScopeAssignmentId_1", "parameters":[ { "name":"scopeItemAssignmentId", "in":"path", "description":"The system-generated identifier of a scope assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope assignment baseline time phased data does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentBaselineTimePhasedData", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"baselineTimePhasedData-scopeAssignment-{scopeItemAssignmentId}-get", "x-filename-id":"baselinetimephaseddata-scopeassignment-scopeitemassignmentid-get" } }, "/installedTimePhasedData":{ "put":{ "tags":[ "Scope Assignment Installed Time Phased Data" ], "summary":"Update a Scope Assignment Installed Time Phased Data ", "description":"Updates the scope assignment installed time phased data for the specified scopeAssignment installed time phased data ID.", "operationId":"/installedTimePhasedData_update_56", "requestBody":{ "description":"The scopeAssignment installed time phased data to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentInstalledTimePhasedDataInput", "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedDataInput", "exampleSetFlag":false }, "examples":{ "Update_Scope_Assignment_Installed_Time_Phased_Data":{ "summary":"Update Scope Assignment Installed Time Phased Data", "description":"Payload to update installed units using the scope assignment installed time-phased data ID.", "value":{ "scopeAssignmentInstalledTimePhasedDataId":50101, "installedUnits":20 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Installed Time Phased Data Service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"installedTimePhasedData-put", "x-filename-id":"installedtimephaseddata-put" }, "post":{ "tags":[ "Scope Assignment Installed Time Phased Data" ], "summary":"Create a Scope Assignment Installed Time Phased Data", "description":"Send a request to this endpoint to create a scope assignment installed time phased data item.", "operationId":"/installedTimePhasedData_create_59", "requestBody":{ "description":"The scopeAssignment installed time phased data to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentInstalledTimePhasedDataInput", "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedDataInput", "exampleSetFlag":false }, "examples":{ "Create_a_Scope_Assignment_Installed_Time_Phased_Data":{ "summary":"Create a Scope Assignment Installed Time Phased Data", "description":"Payload to create scope assignment installed time-phased data using scope assignment ID, date, and installed units.", "value":{ "scopeItemAssignmentId":32001, "date":"2023-03-24T23:02:15", "installedUnits":10 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Installed Time Phased Data Service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentInstalledTimePhasedData", "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedData", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"installedTimePhasedData-post", "x-filename-id":"installedtimephaseddata-post" } }, "/installedTimePhasedData/batch":{ "put":{ "tags":[ "Scope Assignment Installed Time Phased Data" ], "summary":"Batch Update Scope Assignment Installed Time Phased Data ", "description":"Updates the scopeAssignment installed time phased data objects for the specified scopeAssignment installed time phased data IDs.", "operationId":"/installedTimePhasedData/batch_updateBatch_52", "requestBody":{ "description":"scopeAssignment installed time phased data objects to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Scope_Assignment_Installed_Time_Phased_Data":{ "summary":"Batch Update Scope Assignment Installed Time Phased Data", "description":"Payload to update one or more installed units using the scope assignment installed time-phased data IDs.", "value":[ { "scopeAssignmentInstalledTimePhasedDataId":50102, "installedUnits":20 }, { "scopeAssignmentInstalledTimePhasedDataId":50103, "installedUnits":20 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Installed Time Phased Data Service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"installedTimePhasedData-batch-put", "x-filename-id":"installedtimephaseddata-batch-put" }, "post":{ "tags":[ "Scope Assignment Installed Time Phased Data" ], "summary":"Batch Create Scope Assignment Installed Time Phased Data ", "description":"Send a request to this endpoint to create one or more scope assignment installed time phased data items.", "operationId":"/installedTimePhasedData/batch_createBatch_54", "requestBody":{ "description":"scopeAssignment installed time phased data items to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Scope_Assignment_Installed_Time_Phased_Data":{ "summary":"Batch Create Scope Assignment Installed Time Phased Data", "description":"Payload to create one or more scope assignment installed time-phased data using scope assignment ID, date, and installed units.", "value":[ { "scopeItemAssignmentId":32002, "date":"2023-03-21T23:02:15", "installedUnits":10 }, { "scopeItemAssignmentId":32002, "date":"2023-03-22T23:02:15", "installedUnits":10 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Installed Time Phased Data Service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedData", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"installedTimePhasedData-batch-post", "x-filename-id":"installedtimephaseddata-batch-post" }, "delete":{ "tags":[ "Scope Assignment Installed Time Phased Data" ], "summary":"Batch Delete Scope Assignment Installed Time Phased Data ", "description":"Deletes the scope assignment installed time phased data for the specified scopeAssignment installed time phased data IDs.", "operationId":"/installedTimePhasedData/batch_deleteBatch_52", "requestBody":{ "description":"IDs of the scopeAssignment installed time phased data to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Scope Assignment Installed Time Phased Data Service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"installedTimePhasedData-batch-delete", "x-filename-id":"installedtimephaseddata-batch-delete" } }, "/installedTimePhasedData/{scopeAssignmentInstalledTimePhasedDataId}":{ "get":{ "tags":[ "Scope Assignment Installed Time Phased Data" ], "summary":"View Scope Assignment Installed Time Phased Data ", "description":"Returns the scope assignment installed time phased data for the specified scopeAssignment installed time phased data ID.", "operationId":"/installedTimePhasedData/{scopeAssignmentInstalledTimePhasedDataId}_find_76", "parameters":[ { "name":"scopeAssignmentInstalledTimePhasedDataId", "in":"path", "description":"ID of the scopeAssignment installed time phased data to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope assignment installed time phased data does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentInstalledTimePhasedData", "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedData", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"installedTimePhasedData-{scopeAssignmentInstalledTimePhasedDataId}-get", "x-filename-id":"installedtimephaseddata-scopeassignmentinstalledtimephaseddataid-get" }, "delete":{ "tags":[ "Scope Assignment Installed Time Phased Data" ], "summary":"Delete a Scope Assignment Installed Time Phased Data ", "description":"Deletes the scope assignment installed time phased data for the specified scopeAssignment installed time phased data ID.", "operationId":"/installedTimePhasedData/{scopeAssignmentInstalledTimePhasedDataId}_delete_57", "parameters":[ { "name":"scopeAssignmentInstalledTimePhasedDataId", "in":"path", "description":"ID of the scopeAssignment installed time phased data to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Scope Assignment Installed Time Phased Data Service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"installedTimePhasedData-{scopeAssignmentInstalledTimePhasedDataId}-delete", "x-filename-id":"installedtimephaseddata-scopeassignmentinstalledtimephaseddataid-delete" } }, "/installedTimePhasedData/scopeAssignment/{scopeItemAssignmentId}":{ "get":{ "tags":[ "Scope Assignment Installed Time Phased Data" ], "summary":"View all Scope Assignment Installed Time Phased Data by Scope Assignment ID", "description":"Returns the scope assignment installed time phased data for the specified scopeAssignment ID.", "operationId":"/installedTimePhasedData/scopeAssignment/{scopeItemAssignmentId}_findByScopeAssignmentId_2", "parameters":[ { "name":"scopeItemAssignmentId", "in":"path", "description":"ID of the scopeAssignment to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope assignment installed time phased data does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedData", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"installedTimePhasedData-scopeAssignment-{scopeItemAssignmentId}-get", "x-filename-id":"installedtimephaseddata-scopeassignment-scopeitemassignmentid-get" } }, "/installedTimePhasedData/syncBatch":{ "post":{ "tags":[ "Scope Assignment Installed Time Phased Data" ], "summary":"Batch Sync Scope Assignment Installed Time Phased Data ", "description":"Send a request to this endpoint to create or update one or more scope assignment installed time phased data.", "operationId":"/installedTimePhasedData/syncBatch_syncBatch_55", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any scope assignment installed time phased data record sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more scope assignment installed time phased data objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Scope_Assignment_Installed_Time_Phased_Data":{ "summary":"Batch Create or Update Scope Assignment Installed Time Phased Data", "description":"Payload to create or update one or more scope assignment installed time phase data records using the scope item assignment code, work package code, project code, workspace code, scope item code, date, and installed units.", "value":[ { "scopeItemAssignCode":"SA10", "workPackageCode":"WP10", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "scopeItemCode":"SI01", "date":"2023-07-05T00:00:00", "installedUnits":10 } ], "valueSetFlag":true }, "Batch_Create_or_Update_Scope_Assignment_Installed_Time_Phased_Data_Using_ID":{ "summary":"Batch Create or Update Scope Assignment Installed Time Phased Data Using ID", "description":"Payload to create or update one or more scope assignment installed time phase data records using the scope assignment ID, date, and installed units.", "value":[ { "scopeItemAssignmentId":32001, "date":"2023-03-24T23:02:15", "installedUnits":10 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"installedTimePhasedData-syncBatch-post", "x-filename-id":"installedtimephaseddata-syncbatch-post" } }, "/plannedTimePhasedData":{ "put":{ "tags":[ "Scope Assignment Planned Time Phased Data" ], "summary":"Update a Scope Assignment Planned Time Phased Data Object", "description":"Updates the scopeAssignment planned time phased data for the specified scopeAssignment planned time phased data ID.", "operationId":"/plannedTimePhasedData_update_57", "requestBody":{ "description":"The Scope Assignment planned time phased data to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentPlannedTimePhasedDataInput", "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedDataInput", "exampleSetFlag":false }, "examples":{ "Update_Scope_Assignment_Original_Time_Phased_Data_Using_Codes":{ "summary":"Update Scope Assignment Original Time Phased Data Using Codes", "description":"Payload to update planned units using the scope assignment planned time-phased data ID.", "value":{ "scopeAssignmentPlannedTimePhasedDataId":3, "plannedUnits":20 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"plannedTimePhasedData-put", "x-filename-id":"plannedtimephaseddata-put" }, "post":{ "tags":[ "Scope Assignment Planned Time Phased Data" ], "summary":"Create a Scope Assignment Planned Time Phased Data Object", "description":"Creates a scopeAssignment planned time phased data.", "operationId":"/plannedTimePhasedData_create_60", "requestBody":{ "description":"The scopeAssignment planned time phased data to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentPlannedTimePhasedDataInput", "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedDataInput", "exampleSetFlag":false }, "examples":{ "Create_a_Scope_Assignment_Original_Time_Phased_Data":{ "summary":"Create a Scope Assignment Original Time Phased Data", "description":"Payload to create scope assignment original time phase data using the scope assignment ID, date, planned hours, planned units, and scope assignment planned time-phased cost data.", "value":{ "scopeItemAssignmentId":32001, "date":"2023-03-21T23:02:15", "plannedHours":10, "plannedUnits":10, "scopeAssignmentPlannedTimePhasedCostData":{ "plannedCost":100 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentPlannedTimePhasedData", "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedData", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"plannedTimePhasedData-post", "x-filename-id":"plannedtimephaseddata-post" } }, "/plannedTimePhasedData/batch":{ "put":{ "tags":[ "Scope Assignment Planned Time Phased Data" ], "summary":"Batch Update Scope Assignment Planned Time Phased Data ", "description":"Updates the scopeAssignment planned time phased data objects for the specified scopeAssignment planned time phased data IDs.", "operationId":"/plannedTimePhasedData/batch_updateBatch_53", "requestBody":{ "description":"scopeAssignment planned time phased data objects to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Scope_Assignment_Original_Time_Phased_Data":{ "summary":"Batch Update Scope Assignment Original Time Phased Data", "description":"Payload to update one or more planned hours using the scope assignment planned time-phased data IDs.", "value":[ { "scopeAssignmentPlannedTimePhasedDataId":5, "plannedHours":10.5 }, { "scopeAssignmentPlannedTimePhasedDataId":6, "plannedHours":20 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"plannedTimePhasedData-batch-put", "x-filename-id":"plannedtimephaseddata-batch-put" }, "post":{ "tags":[ "Scope Assignment Planned Time Phased Data" ], "summary":"Batch Create Scope Assignment Planned Time Phased Data", "description":"Creates a scopeAssignment planned time phased data.", "operationId":"/plannedTimePhasedData/batch_createBatch_55", "requestBody":{ "description":"scopeAssignment planned time phased data items to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Scope_Assignment_Original_Time_Phased_Data":{ "summary":"Batch Create Scope Assignment Original Time Phased Data", "description":"Payload to create one or more scope assignment planned time-phased data using the scope assignment ID, date, and installed units.", "value":[ { "scopeItemAssignmentId":32001, "date":"2023-03-22T23:02:15", "plannedUnits":10, "plannedHours":10, "scopeAssignmentPlannedTimePhasedCostData":{ "plannedCost":100 } }, { "scopeItemAssignmentId":32002, "date":"2023-03-23T23:02:15", "plannedUnits":10, "plannedHours":10, "scopeAssignmentPlannedTimePhasedCostData":{ "plannedCost":100 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedData", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"plannedTimePhasedData-batch-post", "x-filename-id":"plannedtimephaseddata-batch-post" } }, "/plannedTimePhasedData/{scopeAssignmentPlannedTimePhasedDataId}":{ "get":{ "tags":[ "Scope Assignment Planned Time Phased Data" ], "summary":"View a Scope Assignment Planned Time Phased Data ", "description":"Returns the scopeAssignment planned time phased data for the specified scopeAssignment planned time phased data ID.", "operationId":"/plannedTimePhasedData/{scopeAssignmentPlannedTimePhasedDataId}_find_77", "parameters":[ { "name":"scopeAssignmentPlannedTimePhasedDataId", "in":"path", "description":"ID of the scopeAssignment planned time phased data to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope assignment planned time phased data does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeAssignmentPlannedTimePhasedData", "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedData", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"plannedTimePhasedData-{scopeAssignmentPlannedTimePhasedDataId}-get", "x-filename-id":"plannedtimephaseddata-scopeassignmentplannedtimephaseddataid-get" } }, "/plannedTimePhasedData/scopeAssignment/{scopeItemAssignmentId}":{ "get":{ "tags":[ "Scope Assignment Planned Time Phased Data" ], "summary":"View all Scope Assignment Planned Time Phased Data by Scope Assignment ID", "description":"Returns the scopeAssignment planned time phased data for the specified scopeAssignment ID.", "operationId":"/plannedTimePhasedData/scopeAssignment/{scopeItemAssignmentId}_findByScopeAssignmentId_3", "parameters":[ { "name":"scopeItemAssignmentId", "in":"path", "description":"ID of the scopeAssignment to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope assignment planned time phased data does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedData", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"plannedTimePhasedData-scopeAssignment-{scopeItemAssignmentId}-get", "x-filename-id":"plannedtimephaseddata-scopeassignment-scopeitemassignmentid-get" } }, "/plannedTimePhasedData/syncBatch":{ "post":{ "tags":[ "Scope Assignment Planned Time Phased Data" ], "summary":"Batch Sync Scope Assignment Planned Time Phased Data", "description":"Send a request to this endpoint to create or update one or more scope assignment planned time phased data.", "operationId":"/plannedTimePhasedData/syncBatch_syncBatch_56", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any scope assignment planned time phased data record sent as part of the request.
    Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more scope assignment planned time phased data objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Scope_Assignment_Planned_Time_Phased_Data_Using_ID":{ "summary":"Batch Create or Update Scope Assignment Planned Time Phased Data Using ID", "description":"Payload to create or update one or more scope assignment actual time phased data using the scope assignment ID, date, planned hours, planned units, and scope assignment actual time phased cost data.", "value":[ { "scopeItemAssignmentId":4001, "date":"2023-07-05T00:00:00", "plannedHours":20, "plannedUnits":120, "scopeAssignmentPlannedTimePhasedCostData":{ "plannedCost":200 } } ], "valueSetFlag":true }, "Batch_Create_or_Update_Scope_Assignment_Planned_Time_Phased_Data":{ "summary":"Batch Create or Update Scope Assignment Planned Time Phased Data", "description":"Payload to create or update one or more scope planned actual time phased data records using the scope item assignment code, work package code, project code, workspace code, scope item code, date planned hours, planned units, and scope assignment planned time phase cost data.", "value":[ { "scopeItemAssignCode":"SA10", "workPackageCode":"WP10", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "scopeItemCode":"SI01", "date":"2023-07-06T00:00:00", "plannedHours":20, "plannedUnits":120, "scopeAssignmentPlannedTimePhasedCostData":{ "plannedCost":200 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"plannedTimePhasedData-syncBatch-post", "x-filename-id":"plannedtimephaseddata-syncbatch-post" } }, "/scopeItem":{ "put":{ "tags":[ "Scope Item" ], "summary":"Update a Scope Item", "description":"Send a request to this endpoint to update a scope item.", "operationId":"/scopeItem_update_58", "requestBody":{ "description":"A scope item object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemInput", "$ref":"#/components/schemas/ApiEntityScopeItemInput", "exampleSetFlag":false }, "examples":{ "Update_a_Scope_Item_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Scope Item by Assigning Code Values Using Codes", "description":"Payload to update scope Item using the scope item ID and scopeItemCodeValue fields such as code value code and code type code.", "value":{ "scopeItemId":6101, "scopeItemCodeValue":[ { "codeTypeCode":"Department", "codeValueCode":"POL" } ] }, "valueSetFlag":true }, "Update_a_Scope_Item_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Scope Item by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update scope Item using the scope item ID and scopeItemCodeValue fields such as code value code, code type code and parent ID of parent code value.", "value":{ "scopeItemId":6101, "scopeItemCodeValue":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Update_a_Scope_Item":{ "summary":"Update a Scope Item", "description":"Payload to update planned hours using the scope item ID.", "value":{ "scopeItemId":6101, "plannedHours":50 }, "valueSetFlag":true }, "Update_a_Scope_Item_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Scope Item to Assign a Boolean Configured Field", "description":"Payload to update scope Item using the scope item ID and configured field column label and text value.", "value":{ "scopeItemId":6101, "configuredFields":[ { "columnLabel":"PROJECT_STARTED", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Scope_Item_by_Removing_a_Configured_Field":{ "summary":"Update a Scope Item by Removing a Configured Field", "description":"Payload to update scope Item using the scope item ID and specifying the action and column label for the configured field to be removed.", "value":{ "scopeItemId":6101, "configuredFields":[ { "action":"DELETE", "columnLabel":"PROJECT_STARTED" } ] }, "valueSetFlag":true }, "Update_a_Scope_Item_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Scope Item by Assigning Multiple Code Values Using IDs", "description":"Payload to update scope Item using the scope item ID and scopeItemCodeValue fields such as code value ID and code type ID.", "value":{ "scopeItemId":6101, "scopeItemCodeValue":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":25, "codeValueId":941041 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"scopeItem-put", "x-filename-id":"scopeitem-put" }, "post":{ "tags":[ "Scope Item" ], "summary":"Create a Scope Item", "description":"Send a request to this endpoint to create a scope item.", "operationId":"/scopeItem_create_61", "requestBody":{ "description":"A scope item object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemInput", "$ref":"#/components/schemas/ApiEntityScopeItemInput", "exampleSetFlag":false }, "examples":{ "Create_a_Scope_Item_that_includes_Configured_Field_Text":{ "summary":"Create a Scope Item that includes Configured Field Text", "description":"Payload to create a scope item using the project ID, scope item code, scope item name, PBS ID, unit of measure ID, planned units, planned hours, and values for the configured field which include column name and text value.", "value":{ "itemName":"HVAC-Drawings", "scopeItemCode":"SI01", "pbsId":10103, "projectId":12102, "unitOfMeasureId":1, "plannedUnits":10, "plannedHours":40, "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Scope Item" } ] }, "valueSetFlag":true }, "Create_a_Scope_Item":{ "summary":"Create a Scope Item", "description":"Payload to create a scope item using the project ID, scope item code, scope item name, PBS ID, unit of measure ID, planned units, and planned hours.", "value":{ "itemName":"HVAC-Drawings", "scopeItemCode":"SI01", "pbsId":10103, "projectId":12102, "unitOfMeasureId":1, "plannedUnits":10, "plannedHours":40 }, "valueSetFlag":true }, "Create_a_Scope_Item_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Scope Item that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a scope item using the project ID, scope item code, scope item name, PBS ID, unit of measure ID, planned units, planned hours, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "itemName":"HVAC-Drawings", "scopeItemCode":"SI01", "pbsId":10103, "projectId":12102, "unitOfMeasureId":1, "plannedUnits":10, "plannedHours":40, "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Scope Item" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Scope_Item_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Scope Item by Assigning Code Values Using Codes", "description":"Payload to create a scope item using the project ID, scope item code, scope item name, PBS ID, unit of measure ID, planned units, planned hours, and scopeItemCodeValue fields such as code value code and code type code.", "value":{ "itemName":"HVAC-Drawings", "scopeItemCode":"SI01", "pbsId":10103, "projectId":12102, "unitOfMeasureId":1, "plannedUnits":10, "plannedHours":40, "scopeItemCodeValue":[ { "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Create_a_Scope_Item_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Scope Item by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a scope item using the project ID, scope item code, scope item name, PBS ID, unit of measure ID, planned units, planned hours, and scopeItemCodeValue fields such as code value code, code type code, and parent ID of parent code value.", "value":{ "itemName":"HVAC-Drawings", "scopeItemCode":"SI01", "pbsId":10103, "projectId":12102, "unitOfMeasureId":1, "plannedUnits":10, "plannedHours":40, "scopeItemCodeValue":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Create_a_Scope_Item_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Scope Item Assigning Multiple Code Values Using IDs", "description":"Payload to create a scope item using the project ID, scope item code, scope item name, PBS ID, unit of measure ID, planned units, planned hours, and scopeItemCodeValue fields such as code value ID and code type ID.", "value":{ "itemName":"HVAC-Drawings", "scopeItemCode":"SI01", "pbsId":10103, "projectId":12102, "unitOfMeasureId":1, "plannedUnits":10, "plannedHours":40, "scopeItemCodeValue":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItem", "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-post", "x-filename-id":"scopeitem-post" } }, "/scopeItem/{scopeItemId}":{ "get":{ "tags":[ "Scope Item" ], "summary":"View a Scope Item", "description":"This endpoint returns scope items that meet the following requirements:
    • The object is associated with a scope item with an ID value that matches the value of the {scopeItemId} path parameter.
    ", "operationId":"/scopeItem/{scopeItemId}_find_78", "parameters":[ { "name":"scopeItemId", "in":"path", "description":"The system-generated identifier of a scope item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItem", "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-{scopeItemId}-get", "x-filename-id":"scopeitem-scopeitemid-get" }, "delete":{ "tags":[ "Scope Item" ], "summary":"Delete a Scope Item", "description":"Send a request to this endpoint to delete a scope item. The application object with an ID value that matches the value of the {scopeItemId} path parameter will be deleted.", "operationId":"/scopeItem/{scopeItemId}_delete_58", "parameters":[ { "name":"scopeItemId", "in":"path", "description":"The system-generated identifier of a scope item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"scopeItem-{scopeItemId}-delete", "x-filename-id":"scopeitem-scopeitemid-delete" } }, "/scopeItem/code/{scopeItemCode}":{ "get":{ "tags":[ "Scope Item" ], "summary":"View a Scope Item by Code", "description":"This endpoint returns scope items that meet the following requirements:
    • The object has a code that matches the value of the {scopeItemCode} path parameter.
    ", "operationId":"/scopeItem/code/{scopeItemCode}_findByCode_15", "parameters":[ { "name":"scopeItemCode", "in":"path", "description":"The user-specified identifier of a scope item.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-code-{scopeItemCode}-get", "x-filename-id":"scopeitem-code-scopeitemcode-get" } }, "/scopeItem/project/{projectId}/code/{scopeItemCode}":{ "get":{ "tags":[ "Scope Item" ], "summary":"View all Scope Items by Code and Project", "description":"This endpoint returns scope items that meet the following requirements:
    • The object has a code that matches the value of the {scopeItemCode} path parameter.
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    ", "operationId":"/scopeItem/project/{projectId}/code/{scopeItemCode}_findByCodeAndProjectId_4", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"scopeItemCode", "in":"path", "description":"The user-specified identifier of a scope item.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-project-{projectId}-code-{scopeItemCode}-get", "x-filename-id":"scopeitem-project-projectid-code-scopeitemcode-get" } }, "/scopeItem/project/{projectId}/name/{itemName}":{ "get":{ "tags":[ "Scope Item" ], "summary":"View all Scope Items by Name", "description":"This endpoint returns scope items that meet the following requirements:
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    • The object has a name that matches the value of the {itemName} path parameter.
    ", "operationId":"/scopeItem/project/{projectId}/name/{itemName}_findByName_15", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"itemName", "in":"path", "description":"The name of a scope item.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-project-{projectId}-name-{itemName}-get", "x-filename-id":"scopeitem-project-projectid-name-itemname-get" } }, "/scopeItem/project/{projectId}":{ "get":{ "tags":[ "Scope Item" ], "summary":"View Scope Items by Project", "description":"This endpoint returns scope items that meet the following requirements:
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    ", "operationId":"/scopeItem/project/{projectId}_findByProject_13", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-project-{projectId}-get", "x-filename-id":"scopeitem-project-projectid-get" } }, "/scopeItem/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Scope Item" ], "summary":"View all Scope Items by Assigned Configured Field Value", "description":"This endpoint returns scope items that meet the following requirements:
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
    ", "operationId":"/scopeItem/project/{projectId}/configuredField/{viewColumnName}/{value}_findByUDFValue_6", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"scopeitem-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/scopeItem/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Scope Item" ], "summary":"View all Scope Items by Assigned Code Value", "description":"This endpoint returns scope items that meet the following requirements:
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    • The object is assigned a code type that matches the value of the {codeTypeId} path parameter and a code value that matches the value of the {codeValueCode} path parameter.
    ", "operationId":"/scopeItem/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}_findScopeItemsByCodeValue", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-project-{projectId}-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"scopeitem-project-projectid-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/scopeItem/parentCode":{ "get":{ "tags":[ "Scope Item" ], "summary":"View all Scope Items by Parent", "description":"Send a request to this endpoint to view all scope items under parent with codes matching the code fields in query parameters.", "operationId":"/scopeItem/parentCode_getAllScopeItemsByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"pbsCode", "in":"query", "description":"The user-specified identifier of a PBS.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-parentCode-get", "x-filename-id":"scopeitem-parentcode-get" } }, "/scopeItem/itemCode":{ "get":{ "tags":[ "Scope Item" ], "summary":"View a Scope Item by Code and Parent Codes", "description":"Send a request to this endpoint to view a scope item with codes matching the code fields in query parameters.", "operationId":"/scopeItem/itemCode_getScopeItemByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"pbsCode", "in":"query", "description":"The user-specified identifier of a PBS.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scopeItemCode", "in":"query", "description":"The user-specified identifier of a scope item.
    This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItem", "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-itemCode-get", "x-filename-id":"scopeitem-itemcode-get" } }, "/scopeItem/pbsId/{pbsId}":{ "get":{ "tags":[ "Scope Item" ], "summary":"View all Scope Items by PBS", "description":"This endpoint returns scope items that meet the following requirements:
    • The object is associated with a PBS with an ID value that matches the value of the {pbsId} path parameter.
    ", "operationId":"/scopeItem/pbsId/{pbsId}_getWBSActivities_1", "parameters":[ { "name":"pbsId", "in":"path", "description":"The system-generated identifier of a PBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItem-pbsId-{pbsId}-get", "x-filename-id":"scopeitem-pbsid-pbsid-get" } }, "/scopeItemAssignment":{ "put":{ "tags":[ "Scope Item Assignment" ], "summary":"Update a Scope Item Assignment", "operationId":"/scopeItemAssignment_update_59", "requestBody":{ "description":"A scope item assignment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemAssignmentInput", "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentInput", "exampleSetFlag":false }, "examples":{ "Update_a_Scope_Assignment_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Scope Assignment to Assign a Boolean Configured Field", "description":"Payload to update the description using the scope item assignment ID and configured field column label and text value.", "value":{ "scopeItemAssignmentId":32001, "configuredFields":[ { "columnLabel":"PROJECT_STARTED", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Scope_Assignment_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Scope Assignment by Assigning Code Values Using Codes", "description":"Payload to update the description using the scope item assignment ID and scopeItemAssignmentCodeValue fields such as code value code and code type code.", "value":{ "scopeItemAssignmentId":32001, "scopeItemAssignmentCodeValue":[ { "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Update_a_Scope_Assignment":{ "summary":"Update a Scope Assignment", "description":"Payload to update the description using the scope item assignment ID.", "value":{ "scopeItemAssignmentId":32001, "description":"Assign HVAC-Design-Drawing to Create-HVAC-Design" }, "valueSetFlag":true }, "Update_a_Scope_Assignment_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Scope Assignment by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the description using the scope item assignment ID and scopeItemAssignmentCodeValue fields such as parentID, code value code, and code type code.", "value":{ "scopeItemAssignmentId":32001, "scopeItemAssignmentCodeValue":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Update_a_Scope_Assignment_by_Removing_a_Configured_Field":{ "summary":"Update a Scope Assignment by Removing a Configured Field", "description":"Payload to update the description using the scope item assignment ID and specifying the action and column label for the configured field to be removed.", "value":{ "scopeItemAssignmentId":32001, "configuredFields":[ { "action":"DELETE", "columnLabel":"PROJECT_STARTED" } ] }, "valueSetFlag":true }, "Update_a_Scope_Assignment_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Scope Assignment by Assigning Code Values Using IDs", "description":"Payload to update the description using the scope item assignment ID and scopeItemAssignmentCodeValue fields such as code type ID and code value ID.", "value":{ "scopeItemAssignmentId":32001, "scopeItemAssignmentCodeValue":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Scope_Assignment_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Scope Assignment by Assigning Multiple Code Values Using IDs", "description":"Payload to update the description using the scope item assignment ID and scopeItemAssignmentCodeValue fields such as code type ID and code value ID.", "value":{ "scopeItemAssignmentId":32001, "scopeItemAssignmentCodeValue":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":25, "codeValueId":941041 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"scopeItemAssignment-put", "x-filename-id":"scopeitemassignment-put" }, "post":{ "tags":[ "Scope Item Assignment" ], "summary":"Create a Scope Item Assignment", "operationId":"/scopeItemAssignment_create_62", "requestBody":{ "description":"A scope item assignment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemAssignmentInput", "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentInput", "exampleSetFlag":false }, "examples":{ "Create_a_Scope_Assignment_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Scope Assignment by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a scope item assignment using the scope item ID, project ID, work package ID, scope item, assignment code, and scopeItemAssignmentCodeValue fields such as parentId, code value code, and code type code.", "value":{ "scopeItemAssignmentCode":"SA10", "scopeItemId":6101, "workPackageId":4001, "projectId":12102, "description":"HVAC-Design-Drawing to Create-HVAC-Design", "scopeItemAssignmentCodeValue":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Create_a_Scope_Assignment_that_includes_Configured_Field_Text":{ "summary":"Create a Scope Assignment that includes Configured Field Text", "description":"Payload to create a scope item assignment using the scope item ID, project ID, work package ID, scope item, assignment code, and values for the configured field which include column name and text value.", "value":{ "scopeItemAssignmentCode":"SA10", "scopeItemId":6101, "workPackageId":4001, "projectId":12102, "description":"HVAC-Design-Drawing to Create-HVAC-Design", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Scope Item Assignment" } ] }, "valueSetFlag":true }, "Create_a_Scope_Assignment":{ "summary":"Create a Scope Assignment", "description":"Payload to create a scope item assignment using the scope item ID, project ID, work package ID, scope item, and assignment code.", "value":{ "scopeItemAssignmentCode":"SA10", "scopeItemId":6101, "workPackageId":4001, "projectId":12102, "description":"HVAC-Design-Drawing to Create-HVAC-Design" }, "valueSetFlag":true }, "Create_a_Scope_Assignment_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Scope Assignment that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a scope item assignment using the scope item ID, project ID, work package ID, scope item, assignment code, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "scopeItemAssignmentCode":"SA10", "scopeItemId":6101, "workPackageId":4001, "projectId":12102, "description":"HVAC-Design-Drawing to Create-HVAC-Design", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Scope Item Assignment" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Scope_Assignment_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Scope Assignment by Assigning Code Values Using Codes", "description":"Payload to create a scope item assignment using the scope item ID, project ID, work package ID, scope item, assignment code, and scopeItemAssignmentCodeValue fields such as code value code and code type code.", "value":{ "scopeItemAssignmentCode":"SA10", "scopeItemId":6101, "workPackageId":4001, "projectId":12102, "description":"HVAC-Design-Drawing to Create-HVAC-Design", "scopeItemAssignmentCodeValue":[ { "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Create_a_Scope_Assignment_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Scope Assignment by Assigning Multiple Code Values Using IDs", "description":"Payload to create a scope item assignment using the scope item ID, project ID, work package ID, scope item, assignment code, and scopeItemAssignmentCodeValue fields such as code value ID and code type ID.", "value":{ "scopeItemAssignmentCode":"SA10", "scopeItemId":6101, "workPackageId":4001, "projectId":12102, "description":"HVAC-Design-Drawing to Create-HVAC-Design", "scopeItemAssignmentCodeValue":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemAssignment", "$ref":"#/components/schemas/ApiEntityScopeItemAssignment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignment-post", "x-filename-id":"scopeitemassignment-post" } }, "/scopeItemAssignment/{scopeItemAssignmentId}":{ "get":{ "tags":[ "Scope Item Assignment" ], "summary":"View a Scope Item Assignment", "description":"This endpoint returns scope item assignments that meet the following requirements:
    • The object has an ID that matches the value of the {scopeItemAssigmentId} path parameter.
    ", "operationId":"/scopeItemAssignment/{scopeItemAssignmentId}_find_79", "parameters":[ { "name":"scopeItemAssignmentId", "in":"path", "description":"The system-generated identifier of a scope item assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemAssignment", "$ref":"#/components/schemas/ApiEntityScopeItemAssignment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignment-{scopeItemAssignmentId}-get", "x-filename-id":"scopeitemassignment-scopeitemassignmentid-get" }, "delete":{ "tags":[ "Scope Item Assignment" ], "summary":"Delete a Scope Item Assignment", "description":"Send a request to this endpoint to delete a scope item assignment. The application object with an ID value that matches the value of the {scopeItemAssignmentId} path parameter will be deleted.", "operationId":"/scopeItemAssignment/{scopeItemAssignmentId}_delete_59", "parameters":[ { "name":"scopeItemAssignmentId", "in":"path", "description":"The system-generated identifier of a scope item assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"scopeItemAssignment-{scopeItemAssignmentId}-delete", "x-filename-id":"scopeitemassignment-scopeitemassignmentid-delete" } }, "/scopeItemAssignment/code/{scopeItemAssignmentCode}":{ "get":{ "tags":[ "Scope Item Assignment" ], "summary":"View all Scope Item Assignments by Code", "description":"This endpoint returns scope item assignments that meet the following requirements:
    • The object has a code that matches the value of the {code} path parameter.
    ", "operationId":"/scopeItemAssignment/code/{scopeItemAssignmentCode}_findByCode_16", "parameters":[ { "name":"scopeItemAssignmentCode", "in":"path", "description":"The user-specified identifier of a scope item assignment.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignment-code-{scopeItemAssignmentCode}-get", "x-filename-id":"scopeitemassignment-code-scopeitemassignmentcode-get" } }, "/scopeItemAssignment/project/{projectId}":{ "get":{ "tags":[ "Scope Item Assignment" ], "summary":"View all Scope Item Assignments by Project", "description":"This endpoint returns scope item assignments that meet the following requirements:
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    ", "operationId":"/scopeItemAssignment/project/{projectId}_findByProject_14", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignment-project-{projectId}-get", "x-filename-id":"scopeitemassignment-project-projectid-get" } }, "/scopeItemAssignment/scope/{scopeItemId}":{ "get":{ "tags":[ "Scope Item Assignment" ], "summary":"View all Scope Item Assignments by Scope Item", "description":"This endpoint returns scope item assignments that meet the following requirements:
    • The object is associated with a scope item with an ID value that matches the value of the {scopeItemId} path parameter.
    ", "operationId":"/scopeItemAssignment/scope/{scopeItemId}_findByScopeItem", "parameters":[ { "name":"scopeItemId", "in":"path", "description":"The system-generated identifier of a scope item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignment-scope-{scopeItemId}-get", "x-filename-id":"scopeitemassignment-scope-scopeitemid-get" } }, "/scopeItemAssignment/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Scope Item Assignment" ], "summary":"View all Scope Item Assignments by Assigned Configured Field Value", "description":"This endpoint returns scope item assignments that meet the following requirements:
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
    ", "operationId":"/scopeItemAssignment/project/{projectId}/configuredField/{viewColumnName}/{value}_findByUDFValue_7", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignment-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"scopeitemassignment-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/scopeItemAssignment/workPackage/{workPackageId}":{ "get":{ "tags":[ "Scope Item Assignment" ], "summary":"View all Scope Item Assignments by Work Package", "description":"This endpoint returns scope item assignments that meet the following requirements:
    • The object is associated with a work package with an ID value that matches the value of the {workPackageId} path parameter.
    ", "operationId":"/scopeItemAssignment/workPackage/{workPackageId}_findByWorkPackage", "parameters":[ { "name":"workPackageId", "in":"path", "description":"The system-generated identifier of a work package.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignment-workPackage-{workPackageId}-get", "x-filename-id":"scopeitemassignment-workpackage-workpackageid-get" } }, "/scopeItemAssignment/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Scope Item Assignment" ], "summary":"View all Scope Item Assignments by Assigned Code Value", "description":"This endpoint returns scope item assignments that meet the following requirements:
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
    • The object is assigned a code type that matches the value of the {codeTypeId} path parameter and a code value that matches the value of the {codeValueCode} path parameter.
    ", "operationId":"/scopeItemAssignment/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}_findScopeItemsByCodeValue_1", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignment-project-{projectId}-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"scopeitemassignment-project-projectid-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/periodCloseoutData/{scopeAssignmentPeriodCloseOutId}":{ "get":{ "tags":[ "Period Closeout Record" ], "summary":"View a Scope Item Assignment Period Closeout", "description":"Send a request to this endpoint to view a scope item assignment period close out data.", "operationId":"/periodCloseoutData/{scopeAssignmentPeriodCloseOutId}_find_80", "parameters":[ { "name":"scopeAssignmentPeriodCloseOutId", "in":"path", "description":"The system-generated identifier of a scope item assignment period close out data.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment on period closeout does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemAssignmentPeriodCloseOut", "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentPeriodCloseOut", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"periodCloseoutData-{scopeAssignmentPeriodCloseOutId}-get", "x-filename-id":"periodcloseoutdata-scopeassignmentperiodcloseoutid-get" } }, "/periodCloseoutData/periodItem/{periodItemId}":{ "get":{ "tags":[ "Period Closeout Record" ], "summary":"View all Scope Item Assignment Period Closeout by Period Item", "description":"Send a request to this endpoint to view all scope item assignment period close out data which have a period item with the {periodItemId} path parameter.", "operationId":"/periodCloseoutData/periodItem/{periodItemId}_findByPeriodItemId", "parameters":[ { "name":"periodItemId", "in":"path", "description":"The system-generated identifier of a period item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment on period closeout does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentPeriodCloseOut", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"periodCloseoutData-periodItem-{periodItemId}-get", "x-filename-id":"periodcloseoutdata-perioditem-perioditemid-get" } }, "/periodCloseoutData/scopeAssignment/{scopeItemAssignmentId}":{ "get":{ "tags":[ "Period Closeout Record" ], "summary":"View all Scope Item Assignment Period Closeout by Scope Item Assignment", "description":"Send a request to this endpoint to view all scope item assignment period close out data which have a scope item assignment with the {scopeItemAssignmentId} path parameter.", "operationId":"/periodCloseoutData/scopeAssignment/{scopeItemAssignmentId}_findByScopeItemAssignmentId", "parameters":[ { "name":"scopeItemAssignmentId", "in":"path", "description":"The system-generated identifier of a scope item assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested scope item assignment on period closeout does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentPeriodCloseOut", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"periodCloseoutData-scopeAssignment-{scopeItemAssignmentId}-get", "x-filename-id":"periodcloseoutdata-scopeassignment-scopeitemassignmentid-get" } }, "/segment/projectSegment/batch":{ "post":{ "tags":[ "CBS Segment" ], "summary":"Create Multiple Project CBS Segments", "description":"Send a request to this endpoint to create one or more CBS Project Segments.", "operationId":"/segment/projectSegment/batch_createBatchProjectSegments", "requestBody":{ "description":"A CBS segment object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetSegmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_Multiple_Project_CBS_Segments":{ "summary":"Create Multiple Project CBS Segments", "description":"Payload to create one or more project cbs segments using the project IDs, segment definition names, and separators.", "value":[ { "projectId":34101, "segmentDefinitionName":"division", "segmentSeparator":"." }, { "projectId":34101, "segmentDefinitionName":"sub-division", "segmentSeparator":"." } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS Segment resource." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetSegment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"segment-projectSegment-batch-post", "x-filename-id":"segment-projectsegment-batch-post" } }, "/segment/projectSegment":{ "post":{ "tags":[ "CBS Segment" ], "summary":"Create a Project CBS Segment", "description":"Send a request to this endpoint to create a project CBS segment. An application object will be created using the JSON data provided in the request body.", "operationId":"/segment/projectSegment_createProjectSegment", "requestBody":{ "description":"A CBS segment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSSheetSegmentInput", "$ref":"#/components/schemas/ApiEntityCBSSheetSegmentInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_CBS_Segment":{ "summary":"Create a Project CBS Segment", "description":"Payload to create a project cbs segment using the project ID, segment definition name, and separator.", "value":{ "projectId":34101, "segmentDefinitionName":"division", "segmentSeparator":"." }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS Segment resource." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSSheetSegment", "$ref":"#/components/schemas/ApiEntityCBSSheetSegment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"segment-projectSegment-post", "x-filename-id":"segment-projectsegment-post" } }, "/segment/workspaceSegment":{ "post":{ "tags":[ "CBS Segment" ], "summary":"Create a Workspace CBS Segment", "description":"Send a request to this endpoint to create a workspace CBS segment. An application object will be created using the JSON data provided in the request body.", "operationId":"/segment/workspaceSegment_createWorkspaceSegment", "requestBody":{ "description":"A CBS segment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSTemplateSegmentInput", "$ref":"#/components/schemas/ApiEntityCBSTemplateSegmentInput", "exampleSetFlag":false }, "examples":{ "Create_a_Workspace_CBS_Segment":{ "summary":"Create a Workspace CBS Segment", "description":"Payload to create a workspace cbs segment using the workspace ID, segment definition name, and separator.", "value":{ "workspaceId":28001, "segmentDefinitionName":"partitions", "segmentSeparator":"." }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS Segment resource." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSTemplateSegment", "$ref":"#/components/schemas/ApiEntityCBSTemplateSegment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"segment-workspaceSegment-post", "x-filename-id":"segment-workspacesegment-post" } }, "/segment/projectSegment/{cbsSheetSegmentId}":{ "get":{ "tags":[ "CBS Segment" ], "summary":"View a Project CBS Segment", "description":"This endpoint returns project CBS segments that meet the following requirements:
    • The object has an ID that matches the value of the {cbsSheetSegmentId} path parameter.
    ", "operationId":"/segment/projectSegment/{cbsSheetSegmentId}_findProjectSegment", "parameters":[ { "name":"cbsSheetSegmentId", "in":"path", "description":"The system-generated identifier of a CBS segment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Returns the project CBS segment for the specified project CBS segment Id", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSSheetSegment", "$ref":"#/components/schemas/ApiEntityCBSSheetSegment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"segment-projectSegment-{cbsSheetSegmentId}-get", "x-filename-id":"segment-projectsegment-cbssheetsegmentid-get" } }, "/segment/workspaceSegment/{cbsTemplateSegmentId}":{ "get":{ "tags":[ "CBS Segment" ], "summary":"View a Workspace CBS Segment", "description":"This endpoint returns workspace CBS segments that meet the following requirements:
    • The object has an ID that matches the value of the {cbsTemplateSegmentId} path parameter.
    ", "operationId":"/segment/workspaceSegment/{cbsTemplateSegmentId}_findWorkspaceSegment", "parameters":[ { "name":"cbsTemplateSegmentId", "in":"path", "description":"The system-generated identifier of a CBS segment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Returns the workspace CBS segment for the specified workspace CBS segment Id", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSTemplateSegment", "$ref":"#/components/schemas/ApiEntityCBSTemplateSegment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"segment-workspaceSegment-{cbsTemplateSegmentId}-get", "x-filename-id":"segment-workspacesegment-cbstemplatesegmentid-get" } }, "/segment/project/{projectId}":{ "get":{ "tags":[ "CBS Segment" ], "summary":"View all Project CBS Segments by Project ID", "description":"This endpoint returns workspace CBS segments that meet the following requirements:
    • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
      • A CBS is used to track, manage, and report costs related to a project.", "operationId":"/segment/project/{projectId}_getProjectSegments", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetSegment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"segment-project-{projectId}-get", "x-filename-id":"segment-project-projectid-get" } }, "/segment/workspace/{workspaceId}":{ "get":{ "tags":[ "CBS Segment" ], "summary":"View all Workspace CBS Segments by Workspace ID", "description":"This endpoint returns workspace CBS segments that meet the following requirements:
      • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        • A CBS is used to track, manage, and report costs related to a project.", "operationId":"/segment/workspace/{workspaceId}_getWorkspaceSegments", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSTemplateSegment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"segment-workspace-{workspaceId}-get", "x-filename-id":"segment-workspace-workspaceid-get" } }, "/segment/projectSegment/syncBatch":{ "post":{ "tags":[ "CBS Segment" ], "summary":"Batch Sync Project Segments", "description":"Send a request to this endpoint to create or update one or more project segments.", "operationId":"/segment/projectSegment/syncBatch_syncBatchProject", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any project segment record sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more project segment objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetSegmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Project_CBS_Segment":{ "summary":"Create or Update a Project CBS Segment", "description":"Payload to create or update a project CBS segment using the project ID, segment definition name, and separator.", "value":[ { "projectId":28001, "segmentDefinitionName":"partitions", "segmentSeparator":"." } ], "valueSetFlag":true }, "Create_or_Update_a_Project_CBS_Segment_Using_Codes":{ "summary":"Create or Update a Project CBS Segment Using Codes", "description":"Payload to create or update a project CBS segment using the project code, segment definition name, and separator. ", "value":[ [ { "projectCode":"Airport Construction", "workspaceCode":"Ananth Constructions", "segmentDefinitionName":"partitions", "segmentSeparator":"." } ] ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"segment-projectSegment-syncBatch-post", "x-filename-id":"segment-projectsegment-syncbatch-post" } }, "/segment/workspaceSegment/syncBatch":{ "post":{ "tags":[ "CBS Segment" ], "summary":"Batch Sync Workspace Segments", "description":"Send a request to this endpoint to create or update one or more workspace segments.", "operationId":"/segment/workspaceSegment/syncBatch_syncBatchWorkspace", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any workspace segment record sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more workspace segment objects.# SHIFTPERIOD #", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSTemplateSegmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Workspace_CBS_Segment":{ "summary":"Create or Update a Workspace CBS Segment", "description":"Payload to create or update a workspace CBS segment using the workspace ID, segment definition name, and separator.", "value":[ { "workspaceId":28001, "segmentDefinitionName":"partitions", "segmentSeparator":"." } ], "valueSetFlag":true }, "Create_or_Update_a_Workspace_CBS_Segment_Using_Codes":{ "summary":"Create or Update a Workspace CBS Segment Using Codes", "description":"Payload to create or update a workspace CBS segment using the workspace code, segment definition name, and separator.", "value":[ { "workspaceCode":"Ananth Constructions", "segmentDefinitionName":"partitions", "segmentSeparator":"." } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"segment-workspaceSegment-syncBatch-post", "x-filename-id":"segment-workspacesegment-syncbatch-post" } }, "/segment/project/batch":{ "put":{ "tags":[ "CBS Segment" ], "summary":"Update Multiple Project CBS Segments", "description":"Send a request to this endpoint to update one or more Project CBS segments.", "operationId":"/segment/project/batch_updateBatchSheetSegments", "requestBody":{ "description":"One or More CBS segment objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetSegmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Update_Multiple_Project_CBS_Segments_Using_CBS_Sheet_Segment_IDs":{ "summary":"Update Multiple Project CBS Segments Using CBS Sheet Segment IDs", "description":"Payload to update the segment definition names and separators of one or more project cbs segments using the cbs sheet segment IDs.", "value":[ { "cbsSheetSegmentId":6001, "segmentDefinitionName":"divisions", "segmentSeparator":"-" }, { "cbsSheetSegmentId":6002, "segmentDefinitionName":"subdivisions", "segmentSeparator":"." } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS Segment resource." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"segment-project-batch-put", "x-filename-id":"segment-project-batch-put" } }, "/segment/workspace/batch":{ "put":{ "tags":[ "CBS Segment" ], "summary":"Update Multiple Workspace CBS Segments", "description":"Send a request to this endpoint to update one or more workspace CBS segments.", "operationId":"/segment/workspace/batch_updateBatchTemplateSegments", "requestBody":{ "description":"One or More CBS segment objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSTemplateSegmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Update_Multiple_Workspace_CBS_Segments_Using_CBS_Template_Segment_IDs":{ "summary":"Update Multiple Workspace CBS Segments Using CBS Template Segment IDs", "description":"Payload to update the segment definition names and separators of one or more workspace cbs segments using the cbs template segment IDs.", "value":[ { "cbsTemplateSegmentId":2001, "segmentDefinitionName":"partitions1", "segmentSeparator":"-" }, { "cbsTemplateSegmentId":2101, "segmentDefinitionName":"partitions2", "segmentSeparator":"-" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS Segment resource." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"segment-workspace-batch-put", "x-filename-id":"segment-workspace-batch-put" } }, "/segment/project":{ "put":{ "tags":[ "CBS Segment" ], "summary":"Update a Project CBS Segment", "description":"This endpoint returns a project CBS segment. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/segment/project_updateSheetSegment", "requestBody":{ "description":"A CBS segment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSSheetSegmentInput", "$ref":"#/components/schemas/ApiEntityCBSSheetSegmentInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_CBS_Segment_Using_CBS_Sheet_Segment_ID":{ "summary":"Update a Project CBS Segment Using CBS Sheet Segment ID", "description":"Payload to update the segment definition name and separator using the cbs sheet segment ID.", "value":{ "cbsSheetSegmentId":6002, "segmentDefinitionName":"subdivisions", "segmentSeparator":"-" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS Segment resource." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"segment-project-put", "x-filename-id":"segment-project-put" } }, "/segment/workspace":{ "put":{ "tags":[ "CBS Segment" ], "summary":"Update a Workspace CBS Segment", "description":"Send a request to this endpoint to update a CBS segment.", "operationId":"/segment/workspace_updateTemplateSegment", "requestBody":{ "description":"A CBS segment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCBSTemplateSegmentInput", "$ref":"#/components/schemas/ApiEntityCBSTemplateSegmentInput", "exampleSetFlag":false }, "examples":{ "Update_a_Workspace_CBS_Segment_Using_CBS_Template_Segment_ID":{ "summary":"Update a Workspace CBS Segment Using CBS Template Segment ID", "description":"Payload to update the segment definition name and separator using the cbs template segment ID.", "value":{ "cbsTemplateSegmentId":2001, "segmentDefinitionName":"partitions1", "segmentSeparator":"-" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the CBS Segment resource." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"segment-workspace-put", "x-filename-id":"segment-workspace-put" } }, "/action/activityspread/calculate":{ "post":{ "tags":[ "Spreads" ], "summary":"Calculate Activity Spread", "description":"Send a request to this endpoint to calculate the activity spread of the selected or all activities in a project for the input list of spread items in the specified timescale. This endpoint returns a job ID upon request execution. Send a request to the View Job Status endpoint to monitor the status of the scheduled jobs. Once the job is complete, download the spread result using the Download Activity/Assignment Spread endpoint.", "operationId":"/action/activityspread/calculate_calcActivitySpread", "requestBody":{ "description":"Details of the activity spread to be calculated for a given project.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCalcActivitySpreadInput", "$ref":"#/components/schemas/ApiEntityCalcActivitySpreadInput", "exampleSetFlag":false }, "examples":{ "Calculate_Activity_Spread_for_Baseline_Quarterly_Timescale":{ "summary":"Calculate Activity Spread for an Earned Value Baseline Project using a Quarterly Timescale", "description":"Payload to calculate the activity spread of all activities in a project's Earned Value baseline for specified spread items using a Quarterly timescale.", "value":{ "projectId":1888907, "activitySpreadItems":[ "plannedTotalCost", "remainingTotalCost", "actualTotalCost", "atCompletionTotalCost" ], "isBaseline":true, "timescale":"QUARTERLY" }, "valueSetFlag":true }, "Calculate_Activity_Spread_for_Selected_Activities_with_Cutoff_Date":{ "summary":"Calculate Activity Spread for Selected Activities using a Cutoff Date", "description":"Payload to calculate the activity spread of selected activities in a project for specified spread items using a cutoff date.", "value":{ "projectId":1888907, "activityIds":[ 10001, 10002 ], "activitySpreadItems":[ "plannedLaborUnits", "plannedNonlaborUnits", "plannedLaborCost", "plannedNonlaborCost", "plannedMaterialCost", "plannedTotalCost", "earnedValueCost", "plannedValueCost" ], "isBaseline":false, "cutoffDate":"2035-01-01T00:00:00", "timescale":"DAILY" }, "valueSetFlag":true }, "Calculate_Activity_Spread_with_Defaults":{ "summary":"Calculate Activity Spread using Defaults", "description":"Payload to calculate the activity spread of all activities in a project for default spread items using a Daily timescale.", "value":{ "projectId":1888907 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-activityspread-calculate-post", "x-filename-id":"action-activityspread-calculate-post" } }, "/action/assignmentspread/calculate":{ "post":{ "tags":[ "Spreads" ], "summary":"Calculate Assignment Spread", "description":"Send a request to this endpoint to calculate the assignment spread of the selected or all assignments in a project for the input list of spread items in the specified timescale. This endpoint returns a job ID upon request execution. Send a request to the View Job Status endpoint to monitor the status of the scheduled jobs. Once the job is complete, download the spread result using the Download Activity/Assignment Spread endpoint.", "operationId":"/action/assignmentspread/calculate_calcAssignmentSpread", "requestBody":{ "description":"Details of the assignment spread to be calculated for a given project.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCalcAssignmentSpreadInput", "$ref":"#/components/schemas/ApiEntityCalcAssignmentSpreadInput", "exampleSetFlag":false }, "examples":{ "Calculate_Assignment_Spread_with_Defaults":{ "summary":"Calculate Assignment Spread using Defaults", "description":"Payload to calculate the assignment spread of all assignments in a project for default spread items using a Daily timescale.", "value":{ "projectId":1888907 }, "valueSetFlag":true }, "Calculate_Assignment_Spread_for_Baseline_Monthly_Timescale":{ "summary":"Calculate Assignment Spread for an Earned Value Baseline Project using a Monthly Timescale", "description":"Payload to calculate the assignment spread for all assignments in a project's Earned Value baseline for specified spread items using a Monthly timescale.", "value":{ "projectId":1888907, "assignmentSpreadItems":[ "plannedUnits" ], "isBaseline":true, "timescale":"MONTHLY" }, "valueSetFlag":true }, "Calculate_Assignment_Spread_for_Selected_Assignments_with_Cutoff_Date":{ "summary":"Calculate Assignment Spread for Selected Assignments using a Cutoff Date", "description":"Payload to calculate the assignment spread of selected assignments in a project for specified spread items using a cutoff date.", "value":{ "projectId":1888907, "assignmentIds":[ 30011, 30022 ], "assignmentSpreadItems":[ "plannedUnits", "plannedCost", "remainingUnits", "remainingCost" ], "isBaseline":false, "cutoffDate":"2035-01-01T00:00:00", "timescale":"DAILY" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Action service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScheduleJob", "$ref":"#/components/schemas/ApiEntityScheduleJob", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-assignmentspread-calculate-post", "x-filename-id":"action-assignmentspread-calculate-post" } }, "/action/spreadResult/{jobId}":{ "get":{ "tags":[ "Spreads" ], "summary":"Download Activity/Assignment Spread", "description":"Send a request to this endpoint to download the activity or assignment spread file once the Calculate Activity/Assignment Spread job has completed. Track the status of the Calculate Activity/Assignment Spread job using the View Job Status endpoint.", "operationId":"/action/spreadResult/{jobId}_download_1", "parameters":[ { "name":"jobId", "in":"path", "description":"The jobId field value returned as part of the Calculate Activity/Assignment Spread endpoint response.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid input for the Action service." }, "200":{ "description":"The response returned by the Download Activity/Assignment Spread endpoint is available as a zip file. Unzip the file to retrieve the JSON file inside the zip file.", "content":{ "application/octet-stream":{ "schema":{ "title":"ApiEntitySpreadOutput", "$ref":"#/components/schemas/ApiEntitySpreadOutput", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"action-spreadResult-{jobId}-get", "x-filename-id":"action-spreadresult-jobid-get" } }, "/strategy":{ "put":{ "tags":[ "Strategy" ], "summary":"Update a Strategy", "description":"Send a request to this endpoint to update a strategy.", "operationId":"/strategy_update_60", "requestBody":{ "description":"A strategy object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyInput", "$ref":"#/components/schemas/ApiEntityStrategyInput", "exampleSetFlag":false }, "examples":{ "Update_a_Strategy_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Strategy by Assigning Code Values Using IDs", "description":"Payload to update the strategy by using the strategy ID and codeValuesStrategy fields such as code type ID and code value ID.", "value":{ "strategyId":1, "codeValuesStrategy":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Strategy_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Strategy to Assign a Boolean Configured Field", "description":"Payload to update the strategy by using the strategy ID and configured field column label and text value.", "value":{ "strategyId":1, "configuredFields":[ { "columnLabel":"STRATEGY_PLANNED", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Strategy_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Strategy by Assigning Code Values Using Codes", "description":"Payload to update the strategy by using the strategy ID and codeValuesStrategy fields such as code value code and code type code.", "value":{ "strategyId":1, "codeValuesStrategy":[ { "codeTypeCode":"Sponsor", "codeValueCode":"Wong" } ] }, "valueSetFlag":true }, "Update_a_Strategy_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Strategy by Assigning Multiple Code Values Using IDs", "description":"Payload to update the strategy by using the strategy ID and codeValuesStrategy fields such as code type ID and code value ID.", "value":{ "strategyId":1, "codeValuesStrategy":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":25, "codeValueId":941041 } ] }, "valueSetFlag":true }, "Update_a_Strategy_by_Removing_a_Configured_Field":{ "summary":"Update a Strategy by Removing a Configured Field", "description":"Payload to update the strategy by using the strategy ID and specifying the action and column label for the configured field to be removed.", "value":{ "strategyId":1, "configuredFields":[ { "action":"DELETE", "columnLabel":"STRATEGY_PLANNED" } ] }, "valueSetFlag":true }, "Update_a_Strategy_by_Assigning_Hierarchical_Code_Values_Using_Code":{ "summary":"Update a Strategy by Assigning Hierarchical Code Values Using Code", "description":"Payload to update the strategy by using the strategy ID and codeValuesStrategy fields such as parentID, code value code and code type code.", "value":{ "strategyId":1, "codeValuesStrategy":[ { "parentId":78009, "codeTypeCode":"Sponsor", "codeValueCode":"Wong" } ] }, "valueSetFlag":true }, "Update_a_Strategy_Using_Strategy_ID":{ "summary":"Update a Strategy Using Strategy ID", "description":"Payload to update a description and strategy name using the strategy ID.", "value":{ "strategyName":"Reduces the Cost", "description":"Strategy to reduce the cost", "strategyId":1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategy-put", "x-filename-id":"strategy-put" }, "post":{ "tags":[ "Strategy" ], "summary":"Create a Strategy", "description":"Send a request to this endpoint to create a strategy.", "operationId":"/strategy_create_63", "requestBody":{ "description":"A strategy object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyInput", "$ref":"#/components/schemas/ApiEntityStrategyInput", "exampleSetFlag":false }, "examples":{ "Create_a_Strategy_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Strategy by Assigning Code Values Using Codes", "description":"Payload to create a strategy using the workspace ID, strategy name, status, strategy type ID, weight percentage, and codeValuesStrategy fields such as code value code and code type code.", "value":{ "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001, "codeValuesStrategy":[ { "codeTypeCode":"Sponsor", "codeValueCode":"Wong" } ] }, "valueSetFlag":true }, "Create_a_Strategy_that_includes_Configured_Field_Text":{ "summary":"Create a Strategy that includes Configured Field Text", "description":"Payload to create a strategy using the workspace ID, owner ID, strategy name, status, strategy type ID, weight percentage, and values for the configured field which include column name and text value.", "value":{ "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001, "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Strategy" } ] }, "valueSetFlag":true }, "Create_a_Strategy_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Strategy that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a strategy using the workspace ID, owner ID, strategy name, status, strategy type ID, weight percentage, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001, "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Strategy" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Strategy_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Strategy by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a strategy using the workspace ID, strategy name, status, strategy type ID, weight percentage, and codeValuesStrategy fields such as parentID, code value code, and code type code.", "value":{ "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001, "codeValuesStrategy":[ { "parentId":78009, "codeTypeCode":"Sponsor", "codeValueCode":"Wong" } ] }, "valueSetFlag":true }, "Create_a_Strategy":{ "summary":"Create a Strategy", "description":"Payload to create a strategy using the workspace ID, owner ID, strategy name, status, strategy type ID, and weight percentage.", "value":{ "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001 }, "valueSetFlag":true }, "Create_a_Strategy_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Strategy by Assigning Multiple Code Values Using IDs", "description":"Payload to create a strategy using the workspace ID, strategy name, status, strategy type ID, weight percentage, and codeValuesStrategy fields such as code value ID and code type ID.", "value":{ "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001, "codeValuesStrategy":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategy", "$ref":"#/components/schemas/ApiEntityStrategy", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategy-post", "x-filename-id":"strategy-post" } }, "/strategy/batch":{ "put":{ "tags":[ "Strategy" ], "summary":"Batch Update Strategies", "description":"Send a request to this endpoint to update one or more strategy configured fields.", "operationId":"/strategy/batch_update_61", "requestBody":{ "description":"One or more strategy objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Strategies_Using_Strategy_IDs":{ "summary":"Batch Update Strategies Using Strategy IDs", "description":"Payload to update the descriptions of one or more strategies using the strategy IDs.", "value":[ { "strategyId":1, "description":"Strategy to reduce the cost" }, { "strategyId":2, "description":"Strategy to increase the revenue" } ], "valueSetFlag":true }, "Batch_Update_Strategies_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Strategies by Assigning Code Values Using Codes or IDs", "description":"Payload to update the one or more strategies using the strategy IDs and codeValuesStrategy fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "strategyId":1, "codeValuesStrategy":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, { "strategyId":2, "codeValuesStrategy":[ { "codeTypeCode":"Functional", "codeValueCode":"MECH" }, { "codeTypeCode":"Sponsor", "codeValueCode":"Wong" } ] } ], "valueSetFlag":true }, "Batch_Update_Strategies_to_Assign_Configured_Field":{ "summary":"Batch Update Strategies to Assign Configured Field", "description":"Payload to update the one or more strategies using the strategy IDs and configured field column name, column label, column definition ID, and text value.", "value":[ { "strategyId":1, "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Strategy" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "strategyId":2, "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of Strategy" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true }, "Batch_Update_Strategies_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Strategies by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the one or more strategies using the strategy IDs and codeValuesStrategy fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "strategyId":1, "codeValuesStrategy":[ { "parentId":78009, "codeTypeCode":"Sponsor", "codeValueCode":"Wong" } ] }, { "strategyId":2, "codeValuesStrategy":[ { "parentId":45008, "codeTypeCode":"Functional", "codeValueCode":"MECH" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"strategy-batch-put", "x-filename-id":"strategy-batch-put" }, "post":{ "tags":[ "Strategy" ], "summary":"Batch Create Strategies", "description":"Send a request to this endpoint to create one or more strategies.", "operationId":"/strategy/batch_create_64", "requestBody":{ "description":"One or more strategy objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Strategies_that_include_Configured_Field_Text":{ "summary":"Batch Create Strategies that include Configured Field Text", "description":"Payload to create one or more strategies using the workspace ID, strategy name, status, strategy type ID, weight percentage, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001, "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Strategy" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "strategyName":"Increases Revenue", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.6667, "workspaceId":3, "ownerId":10001, "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of Strategy" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true }, "Batch_Create_Strategies_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Strategies by Assigning Code Values Using Codes", "description":"Payload to create one or more strategies using the workspace ID, strategy name, status, strategy type ID, weight percentage, and codeValuesStrategy fields such as code value code and code type code.", "value":[ { "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001, "codeValuesStrategy":[ { "codeTypeCode":"Functional", "codeValueCode":"MECH" }, { "codeTypeCode":"Sponsor", "codeValueCode":"Wong" } ] }, { "strategyName":"Increases Revenue", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.6667, "workspaceId":3, "ownerId":10001, "codeValuesStrategy":[ { "codeTypeCode":"Functional", "codeValueCode":"ELE" }, { "codeTypeCode":"Sponsor", "codeValueCode":"James" } ] } ], "valueSetFlag":true }, "Batch_Create_Strategies":{ "summary":"Batch Create Strategies", "description":"Payload to create one or more strategies using the workspace ID, strategy name, status, strategy type ID, and weight percentage.", "value":[ { "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001 }, { "strategyName":"Increases Revenue", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.6667, "workspaceId":3, "ownerId":10001 } ], "valueSetFlag":true }, "Batch_Create_Strategies_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Strategies by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create one or more strategies using the workspace ID, strategy name, status, strategy type ID, weight percentage, and codeValuesStrategy fields such as parentID, code value code, and code type code.", "value":[ { "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "ownerId":10001, "codeValuesStrategy":[ { "parentId":45008, "codeTypeCode":"Functional", "codeValueCode":"MECH" } ] }, { "strategyName":"Increases Revenue", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.6667, "workspaceId":3, "ownerId":10001, "codeValuesStrategy":[ { "parentId":78009, "codeTypeCode":"Sponsor", "codeValueCode":"James" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategy", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategy-batch-post", "x-filename-id":"strategy-batch-post" }, "delete":{ "tags":[ "Strategy" ], "summary":"Batch Deletes Strategies", "description":"Send a request to this endpoint to delete one or more strategy configured fields.", "operationId":"/strategy/batch_delete_61", "requestBody":{ "description":"The system-generated identifier of a strategy.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategy-batch-delete", "x-filename-id":"strategy-batch-delete" } }, "/strategy/{strategyId}":{ "get":{ "tags":[ "Strategy" ], "summary":"View a Strategy", "description":"This endpoint returns strategies that meet the following requirements:
        • The object is associated with a strategy with an ID value that matches the value of the {strategyId} path parameter.
        ", "operationId":"/strategy/{strategyId}_find_81", "parameters":[ { "name":"strategyId", "in":"path", "description":"The system-generated identifier of a strategy.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested strategy does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategy", "$ref":"#/components/schemas/ApiEntityStrategy", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategy-{strategyId}-get", "x-filename-id":"strategy-strategyid-get" }, "delete":{ "tags":[ "Strategy" ], "summary":"Delete a Strategy", "description":"Send a request to this endpoint to delete a strategy. The application object with an ID value that matches the value of the {strategyId} path parameter will be deleted.", "operationId":"/strategy/{strategyId}_delete_60", "parameters":[ { "name":"strategyId", "in":"path", "description":"The system-generated identifier of a strategy.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Strategy service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategy-{strategyId}-delete", "x-filename-id":"strategy-strategyid-delete" } }, "/strategy/measureValue/strategy/{strategyId}":{ "get":{ "tags":[ "Strategy" ], "summary":"View all Strategy Measure Values by Strategy", "description":"This endpoint returns strategies that meet the following requirements:
        • The object is associated with a strategy with an ID value that matches the value of the {strategyId} path parameter.
        ", "operationId":"/strategy/measureValue/strategy/{strategyId}_findWithMeasureValuesByStrategy", "parameters":[ { "name":"strategyId", "in":"path", "description":"The system-generated identifier of a strategy.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested strategy does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyMeasureResponse", "$ref":"#/components/schemas/ApiEntityStrategyMeasureResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategy-measureValue-strategy-{strategyId}-get", "x-filename-id":"strategy-measurevalue-strategy-strategyid-get" } }, "/strategy/measureValue/workspace/{workspaceId}":{ "get":{ "tags":[ "Strategy" ], "summary":"View all Strategies Measure Values by Workspace", "description":"This endpoint returns strategies that meet the following requirements:
        • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        ", "operationId":"/strategy/measureValue/workspace/{workspaceId}_findWithMeasureValuesByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested strategy does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyMeasureResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategy-measureValue-workspace-{workspaceId}-get", "x-filename-id":"strategy-measurevalue-workspace-workspaceid-get" } }, "/strategy/syncBatch":{ "post":{ "tags":[ "Strategy" ], "summary":"Batch Sync Strategies", "description":"Send a request to this endpoint to create or update one or more strategies.", "operationId":"/strategy/syncBatch_syncBatch_57", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any strategy sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more strategy objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Strategies_Using_Workspace_Code":{ "summary":"Create or Update Strategies Using Workspace Code", "description":"Payload to create or update one or more strategies using the workspace code, strategy name, status, strategy type ID, and weight percentage.", "value":[ { "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceCode":"North America" } ], "valueSetFlag":true }, "Create_or_Update_Strategies_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create or Update Strategies by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update one or more strategies using the workspace ID, strategy ID, strategy name, status, strategy type ID, weight percentage, and codeValuesStrategy fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "codeValuesStrategy":[ { "parentId":45008, "codeTypeCode":"Functional", "codeValueCode":"MECH" } ] }, { "strategyId":2, "codeValuesStrategy":[ { "parentId":78008, "codeTypeCode":"Sponsor", "codeValueCode":"Wong" } ] } ], "valueSetFlag":true }, "Create_or_Update_Strategies_Using_Workspace_ID":{ "summary":"Create or Update Strategies Using Workspace ID", "description":"Payload to create or update one or more strategies using the workspace ID, strategy name, status, strategy type ID, and weight percentage.", "value":[ { "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3 } ], "valueSetFlag":true }, "Create_or_Update_Strategies_to_Assign_a_Configured_Field":{ "summary":"Create or Update Strategies to Assign a Configured Field", "description":"Payload to create or update one or more strategies using the workspace ID, strategy ID, strategy name, status, strategy type ID, weight percentage, and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of Strategy" }, { "columnDefinationId":60145, "textValue":"Y" } ] }, { "strategyId":2, "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of Strategy" }, { "columnDefinationId":60245, "numberValue":2 } ] } ], "valueSetFlag":true }, "Create_or_Update_Strategies_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create or Update Strategies by Assigning Code Values Using Codes", "description":"Payload to create or update one or more strategies using the workspace ID, strategy ID, strategy name, status, strategy type ID, weight percentage, and codeValuesStrategy fields such as code value code and code type code.", "value":[ { "strategyName":"Reduces Cost", "status":"ACTIVE", "strategyTypeId":1, "weightPct":0.3333, "workspaceId":3, "codeValuesStrategy":[ { "codeTypeCode":"Functional", "codeValueCode":"MECH" } ] }, { "strategyId":2, "codeValuesStrategy":[ { "codeTypeCode":"Sponsor", "codeValueCode":"Wong" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategy-syncBatch-post", "x-filename-id":"strategy-syncbatch-post" } }, "/strategyMeasure":{ "post":{ "tags":[ "Strategy Measure" ], "summary":"Create a Strategy Measure", "description":"Send a request to this endpoint to create a strategy measure.", "operationId":"/strategyMeasure_create_65", "requestBody":{ "description":"A strategy measure object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyMeasureInput", "$ref":"#/components/schemas/ApiEntityStrategyMeasureInput", "exampleSetFlag":false }, "examples":{ "Create_a_Strategy_Measure":{ "summary":"Create a Strategy Measure", "description":"Payload to create a strategy measure using the strategy ID and measure ID.", "value":{ "measureId":1, "strategyId":1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Measure service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyMeasure", "$ref":"#/components/schemas/ApiEntityStrategyMeasure", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyMeasure-post", "x-filename-id":"strategymeasure-post" } }, "/strategyMeasure/batch":{ "post":{ "tags":[ "Strategy Measure" ], "summary":"Batch Create Strategy Measures", "description":"Send a request to this endpoint to create one or more strategy measures.", "operationId":"/strategyMeasure/batch_create_66", "requestBody":{ "description":"One or more strategy measure objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Strategy_Measures":{ "summary":"Batch Create Strategy Measures", "description":"Payload to create one or more strategy measures using the strategy IDs and measure IDs.", "value":[ { "measureId":1, "strategyId":1 }, { "measureId":2, "strategyId":2 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Measure service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyMeasure-batch-post", "x-filename-id":"strategymeasure-batch-post" }, "delete":{ "tags":[ "Strategy Measure" ], "summary":"Batch Delete Strategy Measures", "description":"Send a request to this endpoint to delete one or more strategy measures.", "operationId":"/strategyMeasure/batch_delete_63", "requestBody":{ "description":"The system-generated identifier of a strategy measure.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Measure service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyMeasure-batch-delete", "x-filename-id":"strategymeasure-batch-delete" } }, "/strategyMeasure/{strategyMeasureId}":{ "get":{ "tags":[ "Strategy Measure" ], "summary":"View a Strategy Measure", "description":"This endpoint returns strategy measures that meet the following requirements:
        • The object has an ID that matches the value of the {strategyMeasureId} path parameter.
        ", "operationId":"/strategyMeasure/{strategyMeasureId}_find_82", "parameters":[ { "name":"strategyMeasureId", "in":"path", "description":"The system-generated identifier of a strategy measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The strategy measure does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyMeasure", "$ref":"#/components/schemas/ApiEntityStrategyMeasure", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyMeasure-{strategyMeasureId}-get", "x-filename-id":"strategymeasure-strategymeasureid-get" }, "delete":{ "tags":[ "Strategy Measure" ], "summary":"Delete a Strategy Measure", "description":"Send a request to this endpoint to delete a strategy measure. The application object with an ID value that matches the value of the {strategyMeasureId} path parameter will be deleted.", "operationId":"/strategyMeasure/{strategyMeasureId}_delete_62", "parameters":[ { "name":"strategyMeasureId", "in":"path", "description":"The system-generated identifier of a strategy measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Strategy Measure service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyMeasure-{strategyMeasureId}-delete", "x-filename-id":"strategymeasure-strategymeasureid-delete" } }, "/strategyMeasure/parentCode":{ "get":{ "tags":[ "Strategy Measure" ], "summary":"View all Strategy Measures by Parent", "description":"Send a request to this endpoint to view all strategy measures under parent with codes matching the code fields in query parameters.", "operationId":"/strategyMeasure/parentCode_getAllStrategyMeasureByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"measureName", "in":"query", "description":"The name of a measure.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The strategy measure does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyMeasure-parentCode-get", "x-filename-id":"strategymeasure-parentcode-get" } }, "/strategyMeasureManualValue":{ "put":{ "tags":[ "Strategy Measure Manual Value" ], "summary":"Update a Strategy Measure Manual Value", "description":"Send a request to this endpoint to update a strategy measure manual value.", "operationId":"/strategyMeasureManualValue_update_62", "requestBody":{ "description":"A strategy measure manual value object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyMeasureValueXReferenceInput", "$ref":"#/components/schemas/ApiEntityStrategyMeasureValueXReferenceInput", "exampleSetFlag":false }, "examples":{ "Update_a_Strategy_Measure_Manual_Value_Using_Strategy_Measure_Manual_Value_ID":{ "summary":"Update a Strategy Measure Manual Value Using Strategy Measure Manual Value ID", "description":"Payload to update the end date of a Strategy Measure Manual Value using the strategy measure manual value ID.", "value":{ "strategyMeasureManualValueId":1, "endDate":"2022-04-18T00:00:00" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Measure Manual Value service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyMeasureManualValue-put", "x-filename-id":"strategymeasuremanualvalue-put" }, "post":{ "tags":[ "Strategy Measure Manual Value" ], "summary":"Create a Strategy Measure Manual Value", "description":"Send a request to this endpoint to create a strategy measure manual value.", "operationId":"/strategyMeasureManualValue_create_67", "requestBody":{ "description":"A strategy measure manual value object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyMeasureValueXReferenceInput", "$ref":"#/components/schemas/ApiEntityStrategyMeasureValueXReferenceInput", "exampleSetFlag":false }, "examples":{ "Create_a_Strategy_Measure_Manual_Value":{ "summary":"Create a Strategy Measure Manual Value", "description":"Payload to create a Strategy Measure Manual Value using the strategy ID, begin date, end date, and measure ID.", "value":{ "measureId":203, "strategyId":1, "beginDate":"2022-02-06T00:00:00", "endDate":"2022-05-18T00:00:00" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Measure Manual Value service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyMeasureValueXReference", "$ref":"#/components/schemas/ApiEntityStrategyMeasureValueXReference", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyMeasureManualValue-post", "x-filename-id":"strategymeasuremanualvalue-post" } }, "/strategyMeasureManualValue/batch":{ "put":{ "tags":[ "Strategy Measure Manual Value" ], "summary":"Batch Update Strategy Measure Manual Values", "description":"Send a request to this endpoint to update one or more strategy measure manual values.", "operationId":"/strategyMeasureManualValue/batch_update_63", "requestBody":{ "description":"One or more strategy measure manual value objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyMeasureValueXReferenceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_a_Strategy_Measure_Manual_Value_Using_Strategy_Measure_Manual_Value_IDs":{ "summary":"Batch Update a Strategy Measure Manual Value Using Strategy Measure Manual Value IDs", "description":"Payload to update the end dates of one or more Strategy Measure Manual Values using the strategy measure manual value IDs.", "value":[ { "strategyMeasureManualValueId":1, "endDate":"2022-04-18T00:00:00" }, { "strategyMeasureManualValueId":2, "endDate":"2022-04-18T00:00:00" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Measure Manual Value service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"strategyMeasureManualValue-batch-put", "x-filename-id":"strategymeasuremanualvalue-batch-put" }, "post":{ "tags":[ "Strategy Measure Manual Value" ], "summary":"Batch Create Strategy Measure Manual Values", "description":"Send a request to this endpoint to create one or more strategy measure manual values.", "operationId":"/strategyMeasureManualValue/batch_create_68", "requestBody":{ "description":"One or more strategy measure manual value objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyMeasureValueXReferenceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Strategy_Measure_Manual_Values":{ "summary":"Batch Create Strategy Measure Manual Values", "description":"Payload to create one or more Strategy Measure Manual Values using the strategy ID, begin date, end date, and measure ID.", "value":[ { "measureId":203, "strategyId":1, "beginDate":"2022-02-06T00:00:00", "endDate":"2022-05-18T00:00:00" }, { "measureId":204, "strategyId":2, "beginDate":"2022-02-06T00:00:00", "endDate":"2022-05-18T00:00:00" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Measure Manual Value service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyMeasureValueXReference", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyMeasureManualValue-batch-post", "x-filename-id":"strategymeasuremanualvalue-batch-post" } }, "/strategyMeasureManualValue/dateSequenceRange/measure/{measureId}":{ "get":{ "tags":[ "Strategy Measure Manual Value" ], "summary":"View all Strategy Measure Manual Value Date Sequences", "description":"This endpoint returns date sequence ranges for strategy measure manual values that meet the following requirements:
        • The object has an ID that matches the value of the {measureId} path parameter.
        ", "operationId":"/strategyMeasureManualValue/dateSequenceRange/measure/{measureId}_getDateSequenceRanges", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested strategy measure manual value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyMeasureValueXReference", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyMeasureManualValue-dateSequenceRange-measure-{measureId}-get", "x-filename-id":"strategymeasuremanualvalue-datesequencerange-measure-measureid-get" } }, "/strategyMeasureValue/strategyMeasureSpread/measure/{measureId}/strategy/{strategyId}":{ "get":{ "tags":[ "Strategy Measure Value" ], "summary":"View a Strategy Measure Value Trend", "description":"This endpoint returns strategy measure trends that meet the following requirements:
        • The object has an ID that matches the value of the {measureId} path parameter.
        • The object has an ID that matches the value of the {strategyId} path parameter.
        ", "operationId":"/strategyMeasureValue/strategyMeasureSpread/measure/{measureId}/strategy/{strategyId}_getStrategyMeasureValueTrendData", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"strategyId", "in":"path", "description":"The system-generated identifier of a strategy.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested strategy measure value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasureSpreadItem", "$ref":"#/components/schemas/ApiEntityMeasureSpreadItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyMeasureValue-strategyMeasureSpread-measure-{measureId}-strategy-{strategyId}-get", "x-filename-id":"strategymeasurevalue-strategymeasurespread-measure-measureid-strategy-strategyid-get" } }, "/strategyProject":{ "put":{ "tags":[ "Strategy Project" ], "summary":"Update a Strategy Project ", "description":"Send a request to this endpoint to update a strategy project.", "operationId":"/strategyProject_update_64", "requestBody":{ "description":"A strategy project object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyProjectInput", "$ref":"#/components/schemas/ApiEntityStrategyProjectInput", "exampleSetFlag":false }, "examples":{ "Update_a_Strategy_Project_Using_Strategy_Project_ID":{ "summary":"Update a Strategy Project Using Strategy Project ID", "description":"Payload to update the percent alignment of the strategy project using the strategy project ID.", "value":{ "strategyProjectId":1, "percentAlignment":0.7 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Project service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyProject-put", "x-filename-id":"strategyproject-put" }, "post":{ "tags":[ "Strategy Project" ], "summary":"Create a Strategy Project", "description":"Send a request to this endpoint to create a strategy project.", "operationId":"/strategyProject_create_69", "requestBody":{ "description":"A strategy project object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyProjectInput", "$ref":"#/components/schemas/ApiEntityStrategyProjectInput", "exampleSetFlag":false }, "examples":{ "Create_a_Strategy_Project":{ "summary":"Create a Strategy Project", "description":"Payload to create a strategy project using the project ID, percent alignment, and strategy ID.", "value":{ "projectId":1005, "strategyId":1, "percentAlignment":1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Project service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyProject", "$ref":"#/components/schemas/ApiEntityStrategyProject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyProject-post", "x-filename-id":"strategyproject-post" } }, "/strategyProject/batch":{ "put":{ "tags":[ "Strategy Project" ], "summary":"Batch Update Strategy Projects ", "description":"Send a request to this endpoint to update one or more strategy projects.", "operationId":"/strategyProject/batch_update_65", "requestBody":{ "description":"One or more strategy project objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Strategy_Projects_Using_Strategy_Project_IDs":{ "summary":"Batch Update Strategy Projects Using Strategy Project IDs", "description":"Payload to update the percent alignments of one or more strategy projects using the strategy project IDs.", "value":[ { "strategyProjectId":1, "percentAlignment":0.7 }, { "strategyProjectId":2, "percentAlignment":0.4 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Project service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"strategyProject-batch-put", "x-filename-id":"strategyproject-batch-put" }, "post":{ "tags":[ "Strategy Project" ], "summary":"Batch Create Strategy Projects", "description":"Send a request to this endpoint to create one or more strategy projects.", "operationId":"/strategyProject/batch_create_70", "requestBody":{ "description":"One or more strategy project objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Strategy_Projects":{ "summary":"Batch Create Strategy Projects", "description":"Payload to create one or more strategy projects using the project ID, percent alignment, and strategy IDs.", "value":[ { "projectId":1005, "strategyId":1, "percentAlignment":0.8 }, { "projectId":1005, "strategyId":2, "percentAlignment":0.2 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Project service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyProject-batch-post", "x-filename-id":"strategyproject-batch-post" }, "delete":{ "tags":[ "Strategy Project" ], "summary":"Batch Delete Strategy Projects", "description":"Send a request to this endpoint to delete one or more strategy projects.", "operationId":"/strategyProject/batch_delete_65", "requestBody":{ "description":"One or more system-generated identifiers of strategy projects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Project service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyProject-batch-delete", "x-filename-id":"strategyproject-batch-delete" } }, "/strategyProject/{strategyProjectId}":{ "get":{ "tags":[ "Strategy Project" ], "summary":"View a Strategy Project", "description":"This endpoint returns strategy projects that meet the following requirements:
        • The object has an ID that matches the value of the {strategyProjectId} path parameter.
        ", "operationId":"/strategyProject/{strategyProjectId}_find_83", "parameters":[ { "name":"strategyProjectId", "in":"path", "description":"The system-generated identifier of a strategy project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Strategy Project does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyProject", "$ref":"#/components/schemas/ApiEntityStrategyProject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyProject-{strategyProjectId}-get", "x-filename-id":"strategyproject-strategyprojectid-get" }, "delete":{ "tags":[ "Strategy Project" ], "summary":"Delete a Strategy Project", "description":"Send a request to this endpoint to delete a strategy project. The application object with an ID value that matches the value of the {strategyProjectId} path parameter will be deleted.", "operationId":"/strategyProject/{strategyProjectId}_delete_64", "parameters":[ { "name":"strategyProjectId", "in":"path", "description":"The system-generated identifier of a strategy project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Strategy Project service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyProject-{strategyProjectId}-delete", "x-filename-id":"strategyproject-strategyprojectid-delete" } }, "/strategyProject/strategy/{strategyId}/project/{projectId}":{ "delete":{ "tags":[ "Strategy Project" ], "summary":"Delete a Strategy Project by Strategy and Project", "description":"Send a request to this endpoint to delete strategy projects that meet the following requirements:
        • The object is associated with a strategy with an ID value that matches the value of the {strategyId} path parameter.
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        ", "operationId":"/strategyProject/strategy/{strategyId}/project/{projectId}_deleteByStrategyAndProject", "parameters":[ { "name":"strategyId", "in":"path", "description":"The system-generated identifier of a strategy.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Strategy Project service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyProject-strategy-{strategyId}-project-{projectId}-delete", "x-filename-id":"strategyproject-strategy-strategyid-project-projectid-delete" } }, "/strategyProject/strategy/{strategyId}":{ "get":{ "tags":[ "Strategy Project" ], "summary":"View all Strategy Projects by Strategy", "description":"This endpoint returns strategy projects that meet the following requirements:
        • The object is associated with a strategy with an ID value that matches the value of the {strategyId} path parameter.
        ", "operationId":"/strategyProject/strategy/{strategyId}_findByWorkspace_2", "parameters":[ { "name":"strategyId", "in":"path", "description":"The system-generated identifier of a strategy.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Strategy Project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyProject-strategy-{strategyId}-get", "x-filename-id":"strategyproject-strategy-strategyid-get" } }, "/strategyProject/parentCode":{ "get":{ "tags":[ "Strategy Project" ], "summary":"View all Strategy Projects by Parent", "description":"Send a request to this endpoint to view all strategy projects under parent with codes matching the code fields in query parameters.", "operationId":"/strategyProject/parentCode_getAllStrategyProjectByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The Strategy Project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyProject-parentCode-get", "x-filename-id":"strategyproject-parentcode-get" } }, "/strategyType":{ "put":{ "tags":[ "Strategy Type" ], "summary":"Update a Strategy Type", "description":"Send a request to this endpoint to update a strategy type.", "operationId":"/strategyType_update_66", "requestBody":{ "description":"A strategy type object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyTypeInput", "$ref":"#/components/schemas/ApiEntityStrategyTypeInput", "exampleSetFlag":false }, "examples":{ "Update_a_Strategy_Type_Using_Strategy_Type_ID":{ "summary":"Update a Strategy Type Using Strategy Type ID", "description":"Payload to update the level name of a strategy type using the strategy type ID.", "value":{ "levelName":"Enterprise Strategy 1", "strategyTypeId":1 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Type service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyType-put", "x-filename-id":"strategytype-put" }, "post":{ "tags":[ "Strategy Type" ], "summary":"Create a Strategy Type", "description":"Send a request to this endpoint to create a strategy type.", "operationId":"/strategyType_create_71", "requestBody":{ "description":"A strategy type object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyTypeInput", "$ref":"#/components/schemas/ApiEntityStrategyTypeInput", "exampleSetFlag":false }, "examples":{ "Create_a_Strategy_Type":{ "summary":"Create a Strategy Type", "description":"Payload to create a strategy type using the workspace ID, level name, and icon.", "value":{ "levelName":"Enterprise Strategy", "workspaceId":1001, "icon":"STRATEGY_KING" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Type service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyType", "$ref":"#/components/schemas/ApiEntityStrategyType", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyType-post", "x-filename-id":"strategytype-post" } }, "/strategyType/batch":{ "put":{ "tags":[ "Strategy Type" ], "summary":"Batch Update Strategy Types", "description":"Send a request to this endpoint to update strategy types.", "operationId":"/strategyType/batch_update_67", "requestBody":{ "description":"One or more strategy type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Strategy_Types_Using_Strategy_Type_IDs":{ "summary":"Batch Update Strategy Types Using Strategy Type IDs", "description":"Payload to update the level names of one or more strategy types using the strategy type IDs.", "value":[ { "levelName":"Enterprise Strategy 1", "strategyTypeId":1 }, { "levelName":"Department Strategy 1", "strategyTypeId":2 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Type service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"strategyType-batch-put", "x-filename-id":"strategytype-batch-put" }, "post":{ "tags":[ "Strategy Type" ], "summary":"Batch Create Strategy Types", "description":"Send a request to this endpoint to create one or more strategy types.", "operationId":"/strategyType/batch_create_72", "requestBody":{ "description":"One or more strategy type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Strategy_Types":{ "summary":"Batch Create Strategy Types", "description":"Payload to create one or more strategy types using a workspace ID, level name, and icon.", "value":[ { "levelName":"Enterprise Strategy", "workspaceId":1001, "icon":"STRATEGY_KING" }, { "levelName":"Department Strategy", "workspaceId":1001, "icon":"STRATEGY_QUEEN" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Type service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyType-batch-post", "x-filename-id":"strategytype-batch-post" }, "delete":{ "tags":[ "Strategy Type" ], "summary":"Batch Delete Strategy Types", "description":"Send a request to this endpoint to delete one or more strategy types.", "operationId":"/strategyType/batch_delete_67", "requestBody":{ "description":"One or more system-generated identifiers of strategy types.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Type service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyType-batch-delete", "x-filename-id":"strategytype-batch-delete" } }, "/strategyType/{strategyTypeId}":{ "get":{ "tags":[ "Strategy Type" ], "summary":"View a Strategy Type", "description":"This endpoint returns strategy types that meet the following requirements:
        • The object has an ID that matches the value of the {strategyTypeId} path parameter.
        ", "operationId":"/strategyType/{strategyTypeId}_find_84", "parameters":[ { "name":"strategyTypeId", "in":"path", "description":"The system-generated identifier of a strategy type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Strategy Type does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStrategyType", "$ref":"#/components/schemas/ApiEntityStrategyType", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyType-{strategyTypeId}-get", "x-filename-id":"strategytype-strategytypeid-get" }, "delete":{ "tags":[ "Strategy Type" ], "summary":"Delete a Strategy Type", "description":"Send a request to this endpoint to delete a strategy type. The application object with an ID value that matches the value of the {strategyTypeId} path parameter will be deleted.", "operationId":"/strategyType/{strategyTypeId}_delete_66", "parameters":[ { "name":"strategyTypeId", "in":"path", "description":"The system-generated identifier of a strategy type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Strategy Type service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"strategyType-{strategyTypeId}-delete", "x-filename-id":"strategytype-strategytypeid-delete" } }, "/strategyType/workspace/{workspaceId}":{ "get":{ "tags":[ "Strategy Type" ], "summary":"View all Strategy Types by Workspace", "description":"This endpoint returns strategy types that meet the following requirements:
        • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        ", "operationId":"/strategyType/workspace/{workspaceId}_findByWorkspace_3", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The Strategy Type does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyType", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyType-workspace-{workspaceId}-get", "x-filename-id":"strategytype-workspace-workspaceid-get" } }, "/strategyType/syncBatch":{ "post":{ "tags":[ "Strategy Type" ], "summary":"Batch Sync Strategy Types", "description":"Send a request to this endpoint to create or update one or more strategy types.", "operationId":"/strategyType/syncBatch_syncBatch_58", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any strategy type sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more strategy type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyType", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Strategy_Types_Using_Workspace_Code":{ "summary":"Create or Update Strategy Types Using Workspace Code", "description":"Payload to create or update one or more strategy types using the workspace code, level name, and icon.", "value":[ { "levelName":"Enterprise Strategy", "workspaceCode":"North America", "icon":"STRATEGY_KING" } ], "valueSetFlag":true }, "Create_or_Update_Strategy_Types_Using_Workspace_ID":{ "summary":"Create or Update Strategy Types Using Workspace ID", "description":"Payload to create or update one or more strategy types using the workspace ID, level name, and icon.", "value":[ { "levelName":"Enterprise Strategy", "workspaceId":1001, "icon":"STRATEGY_KING" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Strategy Type service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"strategyType-syncBatch-post", "x-filename-id":"strategytype-syncbatch-post" } }, "/threshold":{ "put":{ "tags":[ "Threshold" ], "summary":"Update a Threshold", "description":"Send a request to this endpoint to update a threshold.", "operationId":"/threshold_update_68", "requestBody":{ "description":"One or more threshold objects.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityThresholdInput", "$ref":"#/components/schemas/ApiEntityThresholdInput", "exampleSetFlag":false }, "examples":{ "Update_a_Threshold":{ "summary":"Update a Threshold", "description":"Payload to update a threshold using threshold ID, integer value.", "value":{ "thresholdId":18001, "integerValue":1000 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Threshold service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"threshold-put", "x-filename-id":"threshold-put" }, "post":{ "tags":[ "Threshold" ], "summary":"Create a Threshold", "description":"Send a request to this endpoint to create a threshold.", "operationId":"/threshold_create_73", "requestBody":{ "description":"A threshold object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityThresholdInput", "$ref":"#/components/schemas/ApiEntityThresholdInput", "exampleSetFlag":false }, "examples":{ "Create_a_Threshold":{ "summary":"Create a Threshold", "description":"Payload to create a threshold using logical operators.", "value":{ "operator":"EQUALS" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Threshold service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityThreshold", "$ref":"#/components/schemas/ApiEntityThreshold", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"threshold-post", "x-filename-id":"threshold-post" } }, "/threshold/batch":{ "put":{ "tags":[ "Threshold" ], "summary":"Batch Update Thresholds", "description":"Send a request to this endpoint to update one or more thresholds.", "operationId":"/threshold/batch_updateBatch_54", "requestBody":{ "description":"One or more threshold objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityThresholdInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Thresholds":{ "summary":"Batch Update Thresholds", "description":"Payload to update one or more thresholds using the threshold ID and integer value.", "value":[ { "thresholdId":16002, "integerValue":1000 }, { "thresholdId":16003, "integerValue":1000 }, { "thresholdId":16004, "integerValue":1000, "integerValueUpper":1000000 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Threshold service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"threshold-batch-put", "x-filename-id":"threshold-batch-put" }, "post":{ "tags":[ "Threshold" ], "summary":"Batch Create Thresholds", "description":"Send a request to this endpoint to create one or more thresholds.", "operationId":"/threshold/batch_createBatch_56", "requestBody":{ "description":"One or more threshold objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityThresholdInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Thresholds":{ "summary":"Batch Create Thresholds", "description":"Payload to create one or more thresholds using logical operators.", "value":[ { "operator":"EQUALS" }, { "operator":"LESS_THAN_EQUALS" }, { "operator":"BETWEEN" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Threshold service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityThreshold", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"threshold-batch-post", "x-filename-id":"threshold-batch-post" } }, "/threshold/{thresholdId}":{ "get":{ "tags":[ "Threshold" ], "summary":"View a Threshold", "description":"This endpoint returns thresholds that meet the following requirements:
        • The object has an ID that matches the value of the {thresholdId} path parameter.
        ", "operationId":"/threshold/{thresholdId}_find_85", "parameters":[ { "name":"thresholdId", "in":"path", "description":"The system-generated identifier of a threshold.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested thresholds do not exist, or you do not have access to them." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityThreshold", "$ref":"#/components/schemas/ApiEntityThreshold", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"threshold-{thresholdId}-get", "x-filename-id":"threshold-thresholdid-get" } }, "/unitsOfMeasure":{ "put":{ "tags":[ "Units Of Measure" ], "summary":"Update a Units of Measure", "description":"Send a request to this endpoint to update a unit of measure.", "operationId":"/unitsOfMeasure_update_69", "requestBody":{ "description":"One or more units of measure objects.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityUnitsOfMeasureInput", "$ref":"#/components/schemas/ApiEntityUnitsOfMeasureInput", "exampleSetFlag":false }, "examples":{ "Update_a_Units_of_Measure_Using_Unit_Of_Measure_ID":{ "summary":"Update a Units of Measure Using Unit Of Measure ID", "description":"Payload to update display name of a units of measure using unit of measure ID.", "value":{ "displayName":"New York - Strategy Measure", "unitOfMeasureId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Units of Measure service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"unitsOfMeasure-put", "x-filename-id":"unitsofmeasure-put" }, "post":{ "tags":[ "Units Of Measure" ], "summary":"Create a Units of Measure", "description":"Send a request to this endpoint to create a unit of measure.", "operationId":"/unitsOfMeasure_create_74", "requestBody":{ "description":"A units of measure object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityUnitsOfMeasureInput", "$ref":"#/components/schemas/ApiEntityUnitsOfMeasureInput", "exampleSetFlag":false }, "examples":{ "Create_a_Units_of_Measure":{ "summary":"Create a Units of Measure", "description":"Payload to create a units of measure using workspace ID, key, and display name.", "value":{ "key":"NEW", "displayName":"Strategy Measure", "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Units of Measure service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityUnitsOfMeasure", "$ref":"#/components/schemas/ApiEntityUnitsOfMeasure", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"unitsOfMeasure-post", "x-filename-id":"unitsofmeasure-post" } }, "/unitsOfMeasure/batch":{ "put":{ "tags":[ "Units Of Measure" ], "summary":"Batch Update Units of Measures", "description":"Send a request to this endpoint to update one or more units of measure.", "operationId":"/unitsOfMeasure/batch_updateBatch_55", "requestBody":{ "description":"One or more units of measure objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUnitsOfMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Units_of_Measures_Using_Unit_Of_Measure IDs":{ "summary":"Batch Update Units of Measures Using Unit Of Measure IDs", "description":"Payload to update display name of one or more units of measures using unit of measure IDs.", "value":[ { "displayName":"New York - Strategy Measure", "unitOfMeasureId":10001 }, { "displayName":"New York - Risk Measure", "unitOfMeasureId":10002 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Units of Measure service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"unitsOfMeasure-batch-put", "x-filename-id":"unitsofmeasure-batch-put" }, "post":{ "tags":[ "Units Of Measure" ], "summary":"Batch Create Units of Measures", "description":"Send a request to this endpoint to create one or more units of measure.", "operationId":"/unitsOfMeasure/batch_createBatch_57", "requestBody":{ "description":"One or more units of measure objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUnitsOfMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Units_of_Measures":{ "summary":"Batch Create Units of Measures", "description":"Payload to create one or more units of measure using workspace ID, key, and display name.", "value":[ { "key":"NEW", "displayName":"Strategy Measure", "workspaceId":10001 }, { "key":"NEW", "displayName":"Risk Measure", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Units of Measure service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUnitsOfMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"unitsOfMeasure-batch-post", "x-filename-id":"unitsofmeasure-batch-post" }, "delete":{ "tags":[ "Units Of Measure" ], "summary":"Batch Delete Units of Measures", "description":"Send a request to this endpoint to delete one or more units of measure.", "operationId":"/unitsOfMeasure/batch_deleteBatch_53", "requestBody":{ "description":"The system-generated identifier of a units of measure.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Units of Measure service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"unitsOfMeasure-batch-delete", "x-filename-id":"unitsofmeasure-batch-delete" } }, "/unitsOfMeasure/{unitOfMeasureId}":{ "get":{ "tags":[ "Units Of Measure" ], "summary":"View a Units of Measure ", "description":"This endpoint returns units of measure that meet the following requirements:
        • The object has an ID that matches the value of the {unitOfMeasureId} path parameter.
        ", "operationId":"/unitsOfMeasure/{unitOfMeasureId}_find_86", "parameters":[ { "name":"unitOfMeasureId", "in":"path", "description":"The system-generated identifier of a units of measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested units of measure does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityUnitsOfMeasure", "$ref":"#/components/schemas/ApiEntityUnitsOfMeasure", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"unitsOfMeasure-{unitOfMeasureId}-get", "x-filename-id":"unitsofmeasure-unitofmeasureid-get" }, "delete":{ "tags":[ "Units Of Measure" ], "summary":"Delete a Units of Measure", "description":"Send a request to this endpoint to delete a unit of measure. The application object with an ID value that matches the value of the {unitOfMeasureId} path parameter will be deleted.", "operationId":"/unitsOfMeasure/{unitOfMeasureId}_delete_68", "parameters":[ { "name":"unitOfMeasureId", "in":"path", "description":"The system-generated identifier of a units of measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Units of Measure service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"unitsOfMeasure-{unitOfMeasureId}-delete", "x-filename-id":"unitsofmeasure-unitofmeasureid-delete" } }, "/unitsOfMeasure/code/{key}":{ "get":{ "tags":[ "Units Of Measure" ], "summary":"View all Units of Measures by Code", "description":"This endpoint returns units of measure that meet the following requirements:
        • The object has a code that matches the value of the {key} path parameter.
        ", "operationId":"/unitsOfMeasure/code/{key}_findByCode_17", "parameters":[ { "name":"key", "in":"path", "description":"The user-specified identifier of a units of measure.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested units of measure does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUnitsOfMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"unitsOfMeasure-code-{key}-get", "x-filename-id":"unitsofmeasure-code-key-get" } }, "/unitsOfMeasure/name/{displayName}/workspace/{workspaceId}":{ "get":{ "tags":[ "Units Of Measure" ], "summary":"View all Units of Measures by Name", "description":"This endpoint returns units of measure that meet the following requirements:
        • The object has a name that matches the value of the {displayName} path parameter.
        • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        ", "operationId":"/unitsOfMeasure/name/{displayName}/workspace/{workspaceId}_findByName_16", "parameters":[ { "name":"displayName", "in":"path", "description":"The name of a units of measure.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a units of measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested units of measure does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUnitsOfMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"unitsOfMeasure-name-{displayName}-workspace-{workspaceId}-get", "x-filename-id":"unitsofmeasure-name-displayname-workspace-workspaceid-get" } }, "/unitsOfMeasure/workspace/{workspaceId}":{ "get":{ "tags":[ "Units Of Measure" ], "summary":"View all Units of Measures by Workspace", "description":"This endpoint returns units of measure that meet the following requirements:
        • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        ", "operationId":"/unitsOfMeasure/workspace/{workspaceId}_getUnitsOfMeasuresByWorkspaceId", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested units of measure does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUnitsOfMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"unitsOfMeasure-workspace-{workspaceId}-get", "x-filename-id":"unitsofmeasure-workspace-workspaceid-get" } }, "/unitsOfMeasure/syncBatch":{ "post":{ "tags":[ "Units Of Measure" ], "summary":"Batch Sync Units of Measures", "description":"Send a request to this endpoint to create or update one or more units of measure.", "operationId":"/unitsOfMeasure/syncBatch_syncBatch_59", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any units of measure sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more units of measure objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUnitsOfMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Units_of_Measures":{ "summary":"Create or Update Units of Measures", "description":"Payload to create or update the units of measure using the workspace code, display name, key, and push down type which can be manual or automatic.", "value":[ { "displayName":"Strategy Measure", "key":"NEW", "pushDownType":"MANUAL", "workspaceCode":"North America" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Units of Measure service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"unitsOfMeasure-syncBatch-post", "x-filename-id":"unitsofmeasure-syncbatch-post" } }, "/user":{ "put":{ "tags":[ "User" ], "summary":"Update a User", "description":"Send a request to this endpoint to update general information for a user.", "operationId":"/user_update_70", "requestBody":{ "description":"A user object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityApplicationUserInput", "$ref":"#/components/schemas/ApiEntityApplicationUserInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the user group service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"user-put", "x-filename-id":"user-put" }, "post":{ "tags":[ "User" ], "summary":"Create a User", "description":"Send a request to this endpoint to create a user.", "operationId":"/user_create_75", "requestBody":{ "description":"A user object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityUserInput", "$ref":"#/components/schemas/ApiEntityUserInput", "exampleSetFlag":false }, "examples":{ "Create_a_User":{ "summary":"Create a User", "description":"Payload to create a user using Company ID, office IDs, email, firstname, lastname, and user locale ", "value":{ "companyId":0, "officeIds":[ 4102, 1232 ], "email":"Adams@example.com", "federatedUser":false, "firstName":"Adams", "lastName":"Baker", "mobile":123, "phone":123, "title":"mr.", "productNames":[ "SCHEDULE", "PROGRESS" ], "userType":"USER", "globalProfileId":"1", "useExistingUser":true, "userLocale":"en" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the user group service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityUser", "$ref":"#/components/schemas/ApiEntityUser", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"user-post", "x-filename-id":"user-post" } }, "/user/{userId}":{ "get":{ "tags":[ "User" ], "summary":"View a User", "description":"This endpoint returns users that meet the following requirements:
        • The object is associated with a user with an ID value that matches the value of the {userId} path parameter.
        ", "operationId":"/user/{userId}_find_87", "parameters":[ { "name":"userId", "in":"path", "description":"The system-generated identifier of a user.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested user does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedUser", "$ref":"#/components/schemas/ApiEntityExternallySourcedUser", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"user-{userId}-get", "x-filename-id":"user-userid-get" } }, "/user/ldap/{ldapGuid}":{ "get":{ "tags":[ "User" ], "summary":"View a User by Authentication GUID", "description":"This endpoint returns users that meet the following requirements:
        • The object is associated with a user with an ID value that matches the value of the {ldapGuidId} path parameter.
        ", "operationId":"/user/ldap/{ldapGuid}_findByLdapGuid", "parameters":[ { "name":"ldapGuid", "in":"path", "description":"The unique identifier in the external authentication system (LDAP or IDCS)", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested user does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityExternallySourcedUser", "$ref":"#/components/schemas/ApiEntityExternallySourcedUser", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"user-ldap-{ldapGuid}-get", "x-filename-id":"user-ldap-ldapguid-get" } }, "/user/allUsers":{ "get":{ "tags":[ "User" ], "summary":"View all Users", "description":"Send a request to this endpoint to view all users who have access to the tenant.", "operationId":"/user/allUsers_loadAllUsersUnderTenant", "parameters":[ { "name":"companyId", "in":"query", "description":"The system-generated identifier of a company.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExternallySourcedUser", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"user-allUsers-get", "x-filename-id":"user-allusers-get" } }, "/wbs":{ "put":{ "tags":[ "WBS" ], "summary":"Update a WBS", "description":"Send a request to this endpoint to update a WBS.", "operationId":"/wbs_update_71", "requestBody":{ "description":"A WBS object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWBSInput", "$ref":"#/components/schemas/ApiEntityWBSInput", "exampleSetFlag":false }, "examples":{ "Update_a_WBS":{ "summary":"Update a WBS", "description":"Payload to update the WBS name and description using the WBS ID.", "value":{ "wbsId":2028402, "wbsName":"Stractural Change", "description":"Stracture Change WBS 11" }, "valueSetFlag":true }, "Update_a_WBS_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a WBS by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the WBS using WBS ID and code values fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "wbsId":2028402, "codeValues":[ { "parentId":45209, "codeTypeCode":"Level", "codeValueCode":"1.2" } ] }, "valueSetFlag":true }, "Update_a_WBS_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a WBS by Assigning Multiple Code Values Using IDs", "description":"Payload to update the WBS using WBS ID and code values fields such as code value ID and code type ID", "value":{ "wbsId":2028402, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941041 } ] }, "valueSetFlag":true }, "Update_a_WBS_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a WBS by Assigning Code Values Using IDs", "description":"Payload to update the WBS using WBS ID and code values fields such as code value ID and code type ID.", "value":{ "wbsId":2028402, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_WBS_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a WBS to Assign a Boolean Configured Field", "description":"Payload to update the WBS using WBS ID and configured field column label and text value.", "value":{ "wbsId":2028402, "configuredFields":[ { "columnLabel":"HIDDEN", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_WBS_by_Removing_a_Configured_Field":{ "summary":"Update a WBS by Removing a Configured Field", "description":"Payload to update the WBS using WBS ID and specifying the action and column label for the configured field to be removed.", "value":{ "wbsId":2028402, "configuredFields":[ { "action":"DELETE", "columnLabel":"HIDDEN" } ] }, "valueSetFlag":true }, "Update_a_WBS_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a WBS by Assigning Code Values Using Codes", "description":"Payload to update the WBS using WBS ID and code values fields such as code value code and code type code.", "value":{ "wbsId":2028402, "codeValues":[ { "codeTypeCode":"Level", "codeValueCode":"1" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the WBS service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"wbs-put", "x-filename-id":"wbs-put" }, "post":{ "tags":[ "WBS" ], "summary":"Create a WBS", "description":"Send a request to this endpoint to create a WBS.", "operationId":"/wbs_create_76", "requestBody":{ "description":"A WBS object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWBSInput", "$ref":"#/components/schemas/ApiEntityWBSInput", "exampleSetFlag":false }, "examples":{ "Create_a_WBS_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a WBS that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a WBS using the project ID, WBS name, WBS code, description, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "wbsCode":"WBS012", "wbsName":"Foundation", "description":"Foundation WBS 12", "projectId":1888907, "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of wbs" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_WBS_that_includes_Configured_Field_Text":{ "summary":"Create a WBS that includes Configured Field Text", "description":"Payload to create a WBS using the project ID, WBS name, WBS code, description, and values for the configured field which include column name and text value.", "value":{ "wbsCode":"WBS012", "wbsName":"Foundation", "description":"Foundation WBS 12", "projectId":1888907, "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of wbs" } ] }, "valueSetFlag":true }, "Create_a_WBS_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a WBS by Assigning Code Values Using Codes", "description":"Payload to create a WBS using the project ID, WBS name, WBS code, description, and code values fields such as code value code and code type code.", "value":{ "wbsCode":"WBS012", "wbsName":"Foundation", "description":"Foundation WBS 12", "projectId":1888907, "codeValues":[ { "codeTypeCode":"Level", "codeValueCode":"1" } ] }, "valueSetFlag":true }, "Create_a_WBS_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a WBS by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a WBS using the project ID, WBS name, WBS code, description, and code values fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "wbsCode":"WBS012", "wbsName":"Foundation", "description":"Foundation WBS 12", "projectId":1888907, "codeValues":[ { "parentId":34008, "codeTypeCode":"Level", "codeValueCode":"1.1" } ] }, "valueSetFlag":true }, "Create_a_WBS":{ "summary":"Create a WBS", "description":"Payload to create a WBS using the project ID, WBS name, WBS code, description, and parent WBS codes.", "value":{ "wbsCode":"WBS010", "wbsName":"Foundation", "description":"Foundation WBS 10", "projectId":1888907, "parentWBSCodes":[ "ATP", "Bl-C" ] }, "valueSetFlag":true }, "Create_a_WBS_Using_Codes":{ "summary":"Create a WBS Using Codes", "description":"Payload to create a WBS using the project code, workspace code, WBS name, WBS code, description, and parent WBS codes.", "value":{ "wbsCode":"WBS011", "wbsName":"Stracture", "description":"Stracture WBS 11", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "parentWBSCodes":[ "ATP", "Bl-C" ] }, "valueSetFlag":true }, "Create_a_WBS_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a WBS by Assigning Multiple Code Values Using IDs", "description":"Payload to create a WBS using the project ID, WBS name, WBS code, description, and code values fields such as code value ID and code type ID.", "value":{ "wbsCode":"WBS012", "wbsName":"Foundation", "description":"Foundation WBS 12", "projectId":1888907, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the WBS service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWBS", "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-post", "x-filename-id":"wbs-post" } }, "/wbs/{wbsId}":{ "get":{ "tags":[ "WBS" ], "summary":"View a WBS", "description":"This endpoint returns WBSs that meet the following requirements:
        • The object is associated with a WBS with an ID value that matches the value of the {wbsId} path parameter.
        ", "operationId":"/wbs/{wbsId}_find_88", "parameters":[ { "name":"wbsId", "in":"path", "description":"The system-generated identifier of a WBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested WBS does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWBS", "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-{wbsId}-get", "x-filename-id":"wbs-wbsid-get" }, "delete":{ "tags":[ "WBS" ], "summary":"Delete a WBS", "description":"Send a request to this endpoint to delete a WBS. The application object with an ID value that matches the value of the {wbsId} path parameter will be deleted. Additional options are available to handle activities and tasks associated to the WBS being deleted.", "operationId":"/wbs/{wbsId}_delete_69", "parameters":[ { "name":"wbsId", "in":"path", "description":"The system-generated identifier of a WBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"handleAssociatedObjects", "in":"query", "description":"The options for handling associated objects, activities and tasks, on WBS deletion.
        REASSIGN must be passed to reassign objects in hierarchy to a target WBS.
        DELETE must be passed to delete objects associated to the hierarchy.
        DELETE_ONLY_ACTIVITIES must be passed to delete activities and reassign tasks to the respective parent WBS associated to the hierarchy.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REASSIGN", "DELETE", "DELETE_ONLY_ACTIVITIES" ] } }, { "name":"targetWBSId", "in":"query", "description":"The identifier for the target WBS to which associated objects will be assigned. Target WBS ID is only required when the WBS delete option is set to REASSIGN.# CONSTRAINT", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the WBS service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"wbs-{wbsId}-delete", "x-filename-id":"wbs-wbsid-delete" } }, "/wbs/children/{wbsId}":{ "get":{ "tags":[ "WBS" ], "summary":"View all WBS Children", "description":"This endpoint returns children of WBSs that meet the following requirements:
        • The object is associated with a WBS with an ID value that matches the value of the {wbsId} path parameter.
        ", "operationId":"/wbs/children/{wbsId}_findChildren_1", "parameters":[ { "name":"wbsId", "in":"path", "description":"The system-generated identifier of a parent object.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested WBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-children-{wbsId}-get", "x-filename-id":"wbs-children-wbsid-get" }, "delete":{ "tags":[ "WBS" ], "summary":"Delete all WBS Children", "description":"Send a request to this endpoint to delete all children in the WBS hierarchy of a WBS with an ID value that matches the value of the {wbsId} path parameter. Additional options are available to handle activities and tasks associated to the children in the WBS hierarchy being deleted.", "operationId":"/wbs/children/{wbsId}_deleteChildren_1", "parameters":[ { "name":"wbsId", "in":"path", "description":"The system-generated identifier of a parent object.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"handleAssociatedObjects", "in":"query", "description":"The options for handling associated objects, activities and tasks, on WBS deletion.
        REASSIGN must be passed to reassign objects in hierarchy to a target WBS.
        DELETE must be passed to delete objects associated to the hierarchy.
        DELETE_ONLY_ACTIVITIES must be passed to delete activities and reassign tasks to the respective parent WBS associated to the hierarchy.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REASSIGN", "DELETE", "DELETE_ONLY_ACTIVITIES" ] } }, { "name":"targetWBSId", "in":"query", "description":"The identifier for the target WBS to which associated objects will be assigned. Target WBS ID is only required when the WBS delete option is set to REASSIGN.# CONSTRAINT", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the WBS service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"wbs-children-{wbsId}-delete", "x-filename-id":"wbs-children-wbsid-delete" } }, "/wbs/project/{projectId}/code/{wbsCode}":{ "get":{ "tags":[ "WBS" ], "summary":"View a WBS by Code", "description":"This endpoint returns WBSs that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        • The object has a code that matches the value of the {wbsCode} path parameter.
        ", "operationId":"/wbs/project/{projectId}/code/{wbsCode}_findByCode_18", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"wbsCode", "in":"path", "description":"The user-specified identifier of a WBS.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested WBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-project-{projectId}-code-{wbsCode}-get", "x-filename-id":"wbs-project-projectid-code-wbscode-get" } }, "/wbs/project/{projectId}/name/{wbsName}":{ "get":{ "tags":[ "WBS" ], "summary":"View all WBS by Name", "description":"This endpoint returns WBSs that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        • The object has a name that matches the value of the {wbsName} path parameter.
        ", "operationId":"/wbs/project/{projectId}/name/{wbsName}_findByName_17", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"wbsName", "in":"path", "description":"The name of a WBS.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested WBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-project-{projectId}-name-{wbsName}-get", "x-filename-id":"wbs-project-projectid-name-wbsname-get" } }, "/wbs/project/{projectId}":{ "get":{ "tags":[ "WBS" ], "summary":"View all WBS by Project", "description":"This endpoint returns WBSs that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        ", "operationId":"/wbs/project/{projectId}_findByProject_15", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested WBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-project-{projectId}-get", "x-filename-id":"wbs-project-projectid-get" } }, "/wbs/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "WBS" ], "summary":"View all WBS by Assigned Configured Field Value", "description":"This endpoint returns WBSs that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
        ", "operationId":"/wbs/project/{projectId}/configuredField/{viewColumnName}/{value}_findByUDFValue_8", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested WBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"wbs-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/wbs/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "WBS" ], "summary":"View all WBS by Assigned Code Value", "description":"This endpoint returns WBSs that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        • The object is assigned a code type that matches the value of the {codeTypeId} path parameter with a value that matches the value of the {codeValueCode} path parameter.
        ", "operationId":"/wbs/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}_findWBSByCodeValue", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested WBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-project-{projectId}-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"wbs-project-projectid-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/wbs/wbsCode/{wbsCode}/parentWbsCode/{parentCode}/projectId/{projectId}":{ "get":{ "tags":[ "WBS" ], "summary":"View a WBS by WBS Code, Parent WBS Code, and Project ID", "description":"This endpoint returns WBSs that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        • The object is a child of another object with a code value that matches the value of the {parentCode} path parameter.
        • The object has a code that matches the value of the {wbsCode} path parameter.
        ", "operationId":"/wbs/wbsCode/{wbsCode}/parentWbsCode/{parentCode}/projectId/{projectId}_findWbs", "parameters":[ { "name":"wbsCode", "in":"path", "description":"The user-specified identifier of a WBS.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"parentCode", "in":"path", "description":"The user-specified identifier of the parent object.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested WBS does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWBS", "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-wbsCode-{wbsCode}-parentWbsCode-{parentCode}-projectId-{projectId}-get", "x-filename-id":"wbs-wbscode-wbscode-parentwbscode-parentcode-projectid-projectid-get" } }, "/wbs/{wbsId}/childrenHierarchy":{ "get":{ "tags":[ "WBS" ], "summary":"View all Children in a WBS Hierarchy ", "description":"This endpoint returns children of WBSs that meet the following requirements:
        • The object is associated with a WBS with an ID value that matches the value of the {wbsId} path parameter.
        ", "operationId":"/wbs/{wbsId}/childrenHierarchy_getChildrenHierarchy_2", "parameters":[ { "name":"wbsId", "in":"path", "description":"The system-generated identifier of a WBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested WBS does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-{wbsId}-childrenHierarchy-get", "x-filename-id":"wbs-wbsid-childrenhierarchy-get" } }, "/wbs/notebookTopic/project/{projectId}":{ "get":{ "tags":[ "WBS" ], "summary":"View WBS Notebook Topics", "description":"Send a request to this endpoint to view wbs notebook topics for all wbs under the project matching the path parameter {projectId}.", "operationId":"/wbs/notebookTopic/project/{projectId}_getProjectNotebookTopicsByProject_1", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested activity does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicWBS", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"wbs-notebookTopic-project-{projectId}-get", "x-filename-id":"wbs-notebooktopic-project-projectid-get" } }, "/workManagerTask":{ "put":{ "tags":[ "Task" ], "summary":"Update a Task", "description":"Send a request to this endpoint to update a task.", "operationId":"/workManagerTask_update_72", "parameters":[ { "name":"keepHandOff", "in":"query", "description":"Enabling this boolean flag automatically adjusts the tentativeDueDate of dependent tasks if the updated tentativeDueDate of a task overlaps with that of its predecessor or successor dependent tasks. ", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"A task object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTaskInput", "$ref":"#/components/schemas/ApiEntityWorkManagerTaskInput", "exampleSetFlag":false }, "examples":{ "Update_a_Work_Manager_Task":{ "summary":"Update a Work Manager Task Using Work Manager Task ID", "description":"Payload to update the proposed due date using work manager task ID.", "value":{ "workManagerTaskId":1036401, "proposedDueDate":"2023-03-20T23:59:59" }, "valueSetFlag":true }, "Update_a_Work_Manager_Task_by_Removing_a_Configured_Field":{ "summary":"Update a Work Manager Task by Removing a Configured Field", "description":"Payload to update the work manager task using work manager task ID and specifying the action and column label for the configured field to be removed.", "value":{ "workManagerTaskId":1036401, "configuredFields":[ { "action":"DELETE", "columnLabel":"PROJECT_STARTED" } ] }, "valueSetFlag":true }, "Update_a_Work_Manager_Task_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Work Manager Task by Assigning Multiple Code Values Using IDs", "description":"Payload to update the work manager task using work manager task ID and code values fields such as code value ID and code type ID.", "value":{ "workManagerTaskId":1036401, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":159, "codeValueId":1941941 } ] }, "valueSetFlag":true }, "Update_a_Work_Manager_Task_Using_Codes":{ "summary":"Update a Work Manager Task Using Work Manager Task Code", "description":"Payload to update the proposed due date using work manager task code, project code, and workspace code.", "value":{ "itemCode":"In-Finish-T102", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "proposedDueDate":"2023-03-20T23:59:59" }, "valueSetFlag":true }, "Update_a_Work_Manager_Task_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Work Manager Task by Assigning Code Values Using IDs", "description":"Payload to update the work manager task using work manager task ID and code values fields such as code value ID and code type ID.", "value":{ "workManagerTaskId":1036401, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Work_Manager_Task_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Work Manager Task by Assigning Code Values Using Codes", "description":"Payload to update the work manager task using work manager task ID and code values fields such as code value code and code type code.", "value":{ "workManagerTaskId":1036401, "codeValues":[ { "codeTypeCode":"Division", "codeValueCode":"1" } ] }, "valueSetFlag":true }, "Update_a_Work_Manager_Task_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Work Manager Task by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the work manager task using work manager task ID and code values fields such as code value code, code type code and parent ID of parent code value.", "value":{ "workManagerTaskId":1036401, "codeValues":[ { "parentId":9087, "codeTypeCode":"Division", "codeValueCode":"1" } ] }, "valueSetFlag":true }, "Update_a_Work_Manager_Task_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Work Manager Task to Assign a Boolean Configured Field", "description":"Payload to update the work manager task using work manager task ID and configured field column label and text value.", "value":{ "workManagerTaskId":1036401, "configuredFields":[ { "columnLabel":"PROJECT_STARTED", "textValue":"Y" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Task service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"workManagerTask-put", "x-filename-id":"workmanagertask-put" }, "post":{ "tags":[ "Task" ], "summary":"Create a Task", "description":"Send a request to this endpoint to create a task.", "operationId":"/workManagerTask_create_77", "requestBody":{ "description":"A task object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTaskInput", "$ref":"#/components/schemas/ApiEntityWorkManagerTaskInput", "exampleSetFlag":false }, "examples":{ "Create_a_Work_Manager_Task_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Work Manager Task by Assigning Code Values Using Codes", "description":"Payload to create a work manager task using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility and code values fields such as code value code and code type code.", "value":{ "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59", "codeValues":[ { "codeTypeCode":"Division", "codeValueCode":"1" } ] }, "valueSetFlag":true }, "Create_a_Work_Manager_Task_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Work Manager Task by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a work manager task using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility and code values fields such as code value code, code type code and parent ID of parent code value.", "value":{ "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59", "codeValues":[ { "parentId":9087, "codeTypeCode":"Division", "codeValueCode":"1" } ] }, "valueSetFlag":true }, "Create_a_Work_Manager_Task_that_includes_Configured_Field_Text":{ "summary":"Create a Work Manager Task that includes Configured Field Text", "description":"Payload to create a work manager task using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility, and values for the configured field which include column name and text value.", "value":{ "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Work Manager Task" } ] }, "valueSetFlag":true }, "Create_a_Work_Manager_Task_Using_Codes":{ "summary":"Create a Work Manager Task Using Codes", "description":"Payload to create a work manager task using the project code, workspace code, work manager task name, task code, proposed due date, status, company name, type, and visibility.", "value":{ "itemCode":"In-Finish-T102", "workManagerTaskName":"Interior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "companyName":"stable3a", "proposedDueDate":"2023-03-19T23:59:59" }, "valueSetFlag":true }, "Create_a_Work_Manager_Task_by_Assigning_Multiple_Code_Values_Using_Codes":{ "summary":"Create a Work Manager Task by Assigning Multiple Code Values Using Codes", "description":"Payload to create a work manager task using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility and code values fields such as code value ID and code type ID.", "value":{ "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59", "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Work_Manager_Task_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Work Manager Task that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a work manager task using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Work Manager Task" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Work_Manager_Task":{ "summary":"Create a Work Manager Task", "description":"Payload to create a work manager task using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, and visibility.", "value":{ "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Task service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTask", "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-post", "x-filename-id":"workmanagertask-post" } }, "/workManagerTask/batch":{ "put":{ "tags":[ "Task" ], "summary":"Batch Update Tasks ", "description":"Send a request to this endpoint to update one or more tasks.", "operationId":"/workManagerTask/batch_updateBatch_56", "parameters":[ { "name":"keepHandOff", "in":"query", "description":"Enabling this boolean flag automatically adjusts the tentativeDueDate of dependent tasks if the updated tentativeDueDate of a task overlaps with that of its predecessor or successor dependent tasks. ", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more task objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Work_Manager_Tasks_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Work Manager Tasks by Assigning Code Values Using Codes or IDs", "description":"Payload to update the work manager tasks using the work manager task IDs and codeValues fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "workManagerTaskId":1036403, "codeValues":[ { "codeTypeCode":"Division", "codeValueCode":"1" }, { "codeTypeCode":"Area", "codeValueCode":"Big" } ] }, { "workManagerTaskId":1036404, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":159, "codeValueId":1941941 } ] } ], "valueSetFlag":true }, "Batch_Update_Work_Manager_Tasks_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Work Manager Tasks by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the work manager tasks using the work manager task IDs and codeValues fields such as code value code, code type code, and parent ID of parent code value.", "value":[ { "workManagerTaskId":1036403, "codeValues":[ { "parentId":908768, "codeTypeCode":"Division", "codeValueCode":"1" } ] }, { "workManagerTaskId":1036404, "codeValues":[ { "parentId":908708, "codeTypeCode":"Area", "codeValueCode":"Big" } ] } ], "valueSetFlag":true }, "Batch_Update_Work_Manager_Tasks":{ "summary":"Batch Update Work Manager Tasks Using Work Manager Task IDs", "description":"Payload to update the proposed due date of one or more work manager tasks using the work manager task IDs.", "value":[ { "workManagerTaskId":1036403, "proposedDueDate":"2023-03-21T23:59:59" }, { "workManagerTaskId":1036404, "proposedDueDate":"2023-03-21T23:59:59" } ], "valueSetFlag":true }, "Batch_Update_Work_Manager_Tasks_to_Assign_Configured_Field":{ "summary":"Batch Update Work Manager Tasks to Assign Configured Field", "description":"Payload to update the work manager tasks using the work manager task IDs and configured field column name, column label, column definition ID, and text value.", "value":[ { "workManagerTaskId":1036403, "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Work Manager Task" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "workManagerTaskId":1036404, "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of Work Manager Task" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Task service." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"workManagerTask-batch-put", "x-filename-id":"workmanagertask-batch-put" }, "post":{ "tags":[ "Task" ], "summary":"Batch Create Tasks", "description":"Send a request to this endpoint to create one or more tasks. ", "operationId":"/workManagerTask/batch_createBatch_58", "requestBody":{ "description":"One or more task objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Work_Manager_Tasks_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Work Manager Tasks by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create one or more work manager tasks using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility, and codeValues fields such as code value code, code type code, and parent ID of parent code value.", "value":[ { "itemCode":"Ins-Light-T103", "workManagerTaskName":"Install Liting Fixtures", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-20T23:59:59", "codeValues":[ { "parentId":9086, "codeTypeCode":"Division", "codeValueCode":"1" } ] }, { "itemCode":"Ins-Plumb-T104", "workManagerTaskName":"Install Plumbing Fixtures", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-20T23:59:59", "codeValues":[ { "parentId":90087, "codeTypeCode":"Division", "codeValueCode":"2" } ] } ], "valueSetFlag":true }, "Batch_Create_Work_Manager_Tasks_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Work Manager Tasks by Assigning Code Values Using Codes", "description":"Payload to create one or more work manager tasks using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility, and codeValues fields such as code value code and code type code.", "value":[ { "itemCode":"Ins-Light-T103", "workManagerTaskName":"Install Liting Fixtures", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-20T23:59:59", "codeValues":[ { "codeTypeCode":"Division", "codeValueCode":"1" }, { "codeTypeCode":"Area", "codeValueCode":"Big" } ] }, { "itemCode":"Ins-Plumb-T104", "workManagerTaskName":"Install Plumbing Fixtures", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-20T23:59:59", "codeValues":[ { "codeTypeCode":"Division", "codeValueCode":"2" }, { "codeTypeCode":"Area", "codeValueCode":"Small" } ] } ], "valueSetFlag":true }, "Batch_Create_Work_Manager_Tasks":{ "summary":"Batch Create Work Manager Tasks", "description":"Payload to create one or more work manager tasks using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, and visibility.", "value":[ { "itemCode":"Ins-Light-T103", "workManagerTaskName":"Install Liting Fixtures", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-20T23:59:59" }, { "itemCode":"Ins-Plumb-T104", "workManagerTaskName":"Install Plumbing Fixtures", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-20T23:59:59" } ], "valueSetFlag":true }, "Batch_Create_Work_Manager_Tasks_that_include_Configured_Field_Text":{ "summary":"Batch Create Work Manager Tasks that include Configured Field Text", "description":"Payload to create one or more work manager tasks using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "itemCode":"Ins-Light-T103", "workManagerTaskName":"Install Liting Fixtures", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-20T23:59:59", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Work Manager Task" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "itemCode":"Ins-Plumb-T104", "workManagerTaskName":"Install Plumbing Fixtures", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-20T23:59:59", "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of Work Manager Task" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Task service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-batch-post", "x-filename-id":"workmanagertask-batch-post" }, "delete":{ "tags":[ "Task" ], "summary":"Batch Delete Tasks ", "description":"Send a request to this endpoint to delete one or more tasks.", "operationId":"/workManagerTask/batch_deleteBatch_54", "requestBody":{ "description":"One or more system-generated identifiers of tasks.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Task service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"workManagerTask-batch-delete", "x-filename-id":"workmanagertask-batch-delete" } }, "/workManagerTask/{workManagerTaskId}":{ "get":{ "tags":[ "Task" ], "summary":"View a Task ", "description":"This endpoint returns tasks that meet the following requirements:
        • The object is associated with a task with an ID value that matches the value of the {workManagerTaskId} path parameter.
        ", "operationId":"/workManagerTask/{workManagerTaskId}_find_89", "parameters":[ { "name":"workManagerTaskId", "in":"path", "description":"The system-generated identifier of a task.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested task does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTask", "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-{workManagerTaskId}-get", "x-filename-id":"workmanagertask-workmanagertaskid-get" }, "delete":{ "tags":[ "Task" ], "summary":"Delete a Task ", "description":"Send a request to this endpoint to delete a task. The application object with an ID value that matches the value of the {workManagerTaskId} path parameter will be deleted.", "operationId":"/workManagerTask/{workManagerTaskId}_delete_70", "parameters":[ { "name":"workManagerTaskId", "in":"path", "description":"The system-generated identifier of a task.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Task service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"workManagerTask-{workManagerTaskId}-delete", "x-filename-id":"workmanagertask-workmanagertaskid-delete" } }, "/workManagerTask/activity/{activityId}":{ "get":{ "tags":[ "Task" ], "summary":"View all Tasks by Activity", "description":"This endpoint returns tasks that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {project} path parameter.
        • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
        ", "operationId":"/workManagerTask/activity/{activityId}_findByActivity_3", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"includeCommitments", "in":"query", "description":"Indicates whether a commitment needs to be included in ApiEntityWorkManagerTask.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"The requested task does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-activity-{activityId}-get", "x-filename-id":"workmanagertask-activity-activityid-get" } }, "/workManagerTask/code/{itemCode}":{ "get":{ "tags":[ "Task" ], "summary":"View all Tasks by Code", "description":"This endpoint returns tasks that meet the following requirements:
        • The object has a code that matches the value of the {itemCode} path parameter.
        ", "operationId":"/workManagerTask/code/{itemCode}_findByCode_19", "parameters":[ { "name":"itemCode", "in":"path", "description":"The user-specified identifier of a task.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeCommitments", "in":"query", "description":"Indicates whether a commitment needs to be included in ApiEntityWorkManagerTask.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"The requested task does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-code-{itemCode}-get", "x-filename-id":"workmanagertask-code-itemcode-get" } }, "/workManagerTask/project/{project}/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Task" ], "summary":"View all Tasks by Assigned Code Value", "description":"This endpoint returns tasks that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {project} path parameter.
        • The object is assigned a code type that matches the value of the {codeTypeId} path parameter with a value that matches the value of the {codeValueCode} path parameter.
        ", "operationId":"/workManagerTask/project/{project}/codeType/{codeTypeId}/codeValue/{codeValueCode}_findByCodeValue_4", "parameters":[ { "name":"project", "in":"path", "description":"The system-generated identifier of a code value.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code value type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeCommitments", "in":"query", "description":"Indicates whether a commitment needs to be included in ApiEntityWorkManagerTask.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"The requested task does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-project-{project}-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"workmanagertask-project-project-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/workManagerTask/project/{project}":{ "get":{ "tags":[ "Task" ], "summary":"View all Tasks by Project", "description":"This endpoint returns tasks that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {project} path parameter.
        ", "operationId":"/workManagerTask/project/{project}_findByProjectId_7", "parameters":[ { "name":"project", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"includeCommitments", "in":"query", "description":"Indicates whether a commitment needs to be included in ApiEntityWorkManagerTask.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"The requested task does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-project-{project}-get", "x-filename-id":"workmanagertask-project-project-get" } }, "/workManagerTask/project/{project}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Task" ], "summary":"View all Tasks by Configured Field Values", "description":"This endpoint returns tasks that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {project} path parameter.
        • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
        ", "operationId":"/workManagerTask/project/{project}/configuredField/{viewColumnName}/{value}_findByUDFValue_9", "parameters":[ { "name":"project", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeCommitments", "in":"query", "description":"Indicates whether a commitment needs to be included in ApiEntityWorkManagerTask.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"The requested task does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-project-{project}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"workmanagertask-project-project-configuredfield-viewcolumnname-value-get" } }, "/workManagerTask/wbs/{wbsId}":{ "get":{ "tags":[ "Task" ], "summary":"View all Tasks by WBS", "description":"Send a request to this end point to view all the task records assigned to the wbs specified as a path parameter", "operationId":"/workManagerTask/wbs/{wbsId}_findByWbsId", "parameters":[ { "name":"wbsId", "in":"path", "description":"The system-generated identifier of a WBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"includeCommitments", "in":"query", "description":"Indicates whether a commitment needs to be included in ApiEntityWorkManagerTask.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"The requested task does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-wbs-{wbsId}-get", "x-filename-id":"workmanagertask-wbs-wbsid-get" } }, "/workManagerTask/parentCode":{ "get":{ "tags":[ "Task" ], "summary":"View all Tasks by Parent", "description":"Send a request to this endpoint to view all tasks under parent with codes matching the code fields in query parameters.", "operationId":"/workManagerTask/parentCode_getAllWorkManagerTaskByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace. One of the query parameter workspaceCode or workspaceId is required.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace. One of the query parameter workspaceCode or workspaceId is required.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityCode", "in":"query", "description":"The user-specified identifier of an activity.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeCommitments", "in":"query", "description":"Indicates whether a commitment needs to be included in ApiEntityWorkManagerTask.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"The requested task does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-parentCode-get", "x-filename-id":"workmanagertask-parentcode-get" } }, "/workManagerTask/byCode":{ "get":{ "tags":[ "Task" ], "summary":"View a Task by Code and Parent Codes", "description":"Send a request to this endpoint to view a task with codes matching the code fields in query parameters.", "operationId":"/workManagerTask/byCode_getWorkManagerTaskByCodesAndParent", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"itemCode", "in":"query", "description":"The user-specified name of a task.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"includeCommitments", "in":"query", "description":"Indicates whether a commitment needs to be included in ApiEntityWorkManagerTask.", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTask", "$ref":"#/components/schemas/ApiEntityWorkManagerTask", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-byCode-get", "x-filename-id":"workmanagertask-bycode-get" } }, "/workManagerTask/syncBatch":{ "post":{ "tags":[ "Task" ], "summary":"Batch Sync Tasks", "description":"Send a request to this endpoint to create or update one or more tasks.", "operationId":"/workManagerTask/syncBatch_syncBatch_60", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any task record sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } }, { "name":"keepHandOff", "in":"query", "description":"Enabling this boolean flag automatically adjusts the tentativeDueDate of dependent tasks if the updated tentativeDueDate of a task overlaps with that of its predecessor or successor dependent tasks. ", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more task objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Work_Manager_Task_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create or Update a Work Manager Task by Assigning Code Values Using Codes", "description":"Payload to create or update a work manager task using the project ID, work manager task ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility, and codeValues fields such as code value code, and code type code.", "value":[ { "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59", "codeValues":[ { "codeTypeCode":"Area", "codeValueCode":"Big" } ] }, { "workManagerTaskId":1036403, "codeValues":[ { "codeTypeCode":"Division", "codeValueCode":"1" } ] } ], "valueSetFlag":true }, "Create_or_Update_a_Work_Manager_Task_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create or Update a Work Manager Task by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update a work manager task using the project ID, work manager task ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility, and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59", "codeValues":[ { "parentId":908708, "codeTypeCode":"Area", "codeValueCode":"Big" } ] }, { "workManagerTaskId":1036403, "codeValues":[ { "parentId":908798, "codeTypeCode":"Division", "codeValueCode":"1" } ] } ], "valueSetFlag":true }, "Create_or_Update_a_Work_Manager_Task_to_Assign_a_Configured_Field":{ "summary":"Create or Update a Work Manager Task to Assign a Configured Field", "description":"Payload to create or update a work manager task using the project ID, work manager task ID, work manager task name, task code, proposed due date, status, project company ID, type, visibility, and values for the configured field which include column label, column definition ID, number value and text value.", "value":[ { "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59", "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of Work Manager Task" }, { "columnDefinationId":60145, "textValue":"Y" } ] }, { "workManagerTaskId":1036403, "configuredFields":[ { "columnLabel":"NOTES", "textValue":"Notes of Work Manager Task" }, { "columnDefinationId":60245, "numberValue":2 } ] } ], "valueSetFlag":true }, "Create_or_Update_a_Work_Manager_Task":{ "summary":"Create or Update a Work Manager Task", "description":"Payload to create or update a work manager task using the project ID, work manager task name, task code, proposed due date, status, project company ID, type, and visibility.", "value":[ { "itemCode":"Ex-Finish-T101", "workManagerTaskName":"Exterior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "project":1888907, "projectCompanyId":1996707, "proposedDueDate":"2023-03-18T23:59:59" } ], "valueSetFlag":true }, "Create_or_Update_a_Work_Manager_Task_Using_Codes":{ "summary":"Create or Update a Work Manager Task Using Codes", "description":"Payload to create a work manager task using the project code, workspace code, work manager task name, task code, proposed due date, status, company name, type, and visibility.", "value":[ { "itemCode":"In-Finish-T102", "workManagerTaskName":"Interior Finishes", "status":"NEW", "visibility":"PUBLIC", "type":"TASK", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "companyName":"stable3a", "proposedDueDate":"2023-03-19T23:59:59" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTask-syncBatch-post", "x-filename-id":"workmanagertask-syncbatch-post" } }, "/workManagerTask/updateFavorite/batch":{ "put":{ "tags":[ "Task" ], "summary":"Update Task Favorite Flag", "description":"Send a request to this endpoint to update task favorite flag.", "operationId":"/workManagerTask/updateFavorite/batch_updateTaskFavorite", "requestBody":{ "description":"An object to set favorite flag to task.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskFavoriteInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "404":{ "description":"The requested task does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "400":{ "description":"Invalid input for the Task service." } }, "x-internal-id":"workManagerTask-updateFavorite-batch-put", "x-filename-id":"workmanagertask-updatefavorite-batch-put" } }, "/workManagerTaskDependency/{workManagerTaskDependencyId}":{ "get":{ "tags":[ "Task Handoff" ], "summary":"View a Task Handoff", "description":"Returns the Task Handoff for the specified Task Handoff ID", "operationId":"/workManagerTaskDependency/{workManagerTaskDependencyId}_find_90", "parameters":[ { "name":"workManagerTaskDependencyId", "in":"path", "description":"The system-generated identifier of a task handoff.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTaskDependency", "$ref":"#/components/schemas/ApiEntityWorkManagerTaskDependency", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskDependency-{workManagerTaskDependencyId}-get", "x-filename-id":"workmanagertaskdependency-workmanagertaskdependencyid-get" } }, "/workManagerTaskDependency/workspace/{workspaceCode}/project/{projectCode}/task/{tasksCode}":{ "get":{ "tags":[ "Task Handoff" ], "summary":"View Task Handoff Chain by Workspace, Project and Task Codes", "description":"Send a request to this end point to view the entire task handoff chain by the specified workspace, project and task codes of a task.", "operationId":"/workManagerTaskDependency/workspace/{workspaceCode}/project/{projectCode}/task/{tasksCode}_findByProjectCode", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"Workspace Code for which Task Handoffs to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"path", "description":"Project Code for which Task Handoffs to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"tasksCode", "in":"path", "description":"Task Code for which Task Handoffs to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested Task Handoffs does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskDependency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskDependency-workspace-{workspaceCode}-project-{projectCode}-task-{tasksCode}-get", "x-filename-id":"workmanagertaskdependency-workspace-workspacecode-project-projectcode-task-taskscode-get" } }, "/workManagerTaskDependency/project/{projectId}":{ "get":{ "tags":[ "Task Handoff" ], "summary":"View all Task Handoffs by Project", "description":"Returns the Task Handoffs for the specified Project ID", "operationId":"/workManagerTaskDependency/project/{projectId}_findByProjectId_8", "parameters":[ { "name":"projectId", "in":"path", "description":"Project ID for which Task Handoffs to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Task Handoffs does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskDependency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskDependency-project-{projectId}-get", "x-filename-id":"workmanagertaskdependency-project-projectid-get" } }, "/workManagerTaskDependency/task/{workManagerTaskId}":{ "get":{ "tags":[ "Task Handoff" ], "summary":"View Task Handoff Chain by Task", "description":"Send a request to this end point to view the entire task handoff chain by the specified task ID.", "operationId":"/workManagerTaskDependency/task/{workManagerTaskId}_findByTasksId", "parameters":[ { "name":"workManagerTaskId", "in":"path", "description":"Task ID for which Task Handoffs to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Task Handoffs does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskDependency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskDependency-task-{workManagerTaskId}-get", "x-filename-id":"workmanagertaskdependency-task-workmanagertaskid-get" } }, "/workManagerTaskDependency/workspace/{workspaceCode}/project/{projectCode}":{ "get":{ "tags":[ "Task Handoff" ], "summary":"View all Task Handoffs by Workspace and Project Codes", "description":"Returns the Task Handoffs for the specified Workspace and Project Codes", "operationId":"/workManagerTaskDependency/workspace/{workspaceCode}/project/{projectCode}_findByWorkspaceAndProjectCode", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"Workspace Code for which Task Handoffs to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"path", "description":"Project Code for which Task Handoffs to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested Task Handoffs does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskDependency", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskDependency-workspace-{workspaceCode}-project-{projectCode}-get", "x-filename-id":"workmanagertaskdependency-workspace-workspacecode-project-projectcode-get" } }, "/workPackage":{ "put":{ "tags":[ "Work Package" ], "summary":"Update a Work Package ", "description":"Send a request to this endpoint to update a work package.", "operationId":"/workPackage_update_73", "requestBody":{ "description":"A work package object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkPackageInput", "$ref":"#/components/schemas/ApiEntityWorkPackageInput", "exampleSetFlag":false }, "examples":{ "Update_a_Work_Package_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Work Package by Assigning Code Values Using IDs", "description":"Payload to update the work package using the work package ID and code values fields such as code value ID and code type ID.", "value":{ "workPackageId":4001, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Work_Package_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Work Package by Assigning Code Values Using Codes", "description":"Payload to update the work package using the work package ID and code values fields such as code value code and code type code.", "value":{ "workPackageId":4001, "codeValues":[ { "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Update_a_Work_Package_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Work Package to Assign a Boolean Configured Field", "description":"Payload to update the work package using the work package ID and configured field column label and text value.", "value":{ "workPackageId":4001, "configuredFields":[ { "columnLabel":"PROJECT_STARTED", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Work_Package":{ "summary":"Update a Work Package", "description":"Payload to update the work package original finish date using the work package ID.", "value":{ "workPackageId":4001, "originalFinishDate":"2023-06-30T23:02:15" }, "valueSetFlag":true }, "Update_a_Work_Package_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Work Package by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update the work package using the work package ID and code values fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "workPackageId":4001, "codeValues":[ { "parentId":89002, "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Update_a_Work_Package_by_Removing_a_Configured_Field":{ "summary":"Update a Work Package by Removing a Configured Field", "description":"Payload to update the work package using the work package ID and specifying the action and column label for the configured field to be removed.", "value":{ "workPackageId":4001, "configuredFields":[ { "action":"DELETE", "columnLabel":"PROJECT_STARTED" } ] }, "valueSetFlag":true }, "Update_a_Work_Package_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Work Package by Assigning Multiple Code Values Using IDs", "description":"Payload to update the work package using the work package ID and code values fields such as code value ID and code type ID.", "value":{ "workPackageId":4001, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":20, "codeValueId":940041 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Work Package Change Request Service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"workPackage-put", "x-filename-id":"workpackage-put" }, "post":{ "tags":[ "Work Package" ], "summary":"Create a Work Package", "description":"Send a request to this endpoint to create a work package.", "operationId":"/workPackage_create_78", "requestBody":{ "description":"A work package object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkPackageInput", "$ref":"#/components/schemas/ApiEntityWorkPackageInput", "exampleSetFlag":false }, "examples":{ "Create_a_Work_Package":{ "summary":"Create a Work Package", "description":"Payload to create a work package using the WBS ID, project ID, work package code, and work package name.", "value":{ "workPackageName":"Create-HVAC-Design", "workPackageCode":"WP10", "wbsId":12101, "projectId":12102, "originalStartDate":"2023-03-19T23:02:15", "originalFinishDate":"2023-06-19T23:02:15" }, "valueSetFlag":true }, "Create_a_Work_Package_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Work Package that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a work package using the WBS ID, project ID, work package code, work package name, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "workPackageName":"Create-HVAC-Design", "workPackageCode":"WP10", "wbsId":12101, "projectId":12102, "originalStartDate":"2023-03-19T23:02:15", "originalFinishDate":"2023-06-19T23:02:15", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Work Package" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Work_Package_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Work Package by Assigning Code Values Using Codes", "description":"Payload to create a work package using the WBS ID, project ID, work package code, work package name and code values fields such as code value code and code type code.", "value":{ "workPackageName":"Create-HVAC-Design", "workPackageCode":"WP10", "wbsId":12101, "projectId":12102, "originalStartDate":"2023-03-19T23:02:15", "originalFinishDate":"2023-06-19T23:02:15", "codeValues":[ { "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Create_a_Work_Package_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Work Package Assigning Multiple Code Values Using IDs", "description":"Payload to create a work package using the WBS ID, project ID, work package code, work package name and code values fields such as code value ID and code type ID.", "value":{ "workPackageName":"Create-HVAC-Design", "workPackageCode":"WP10", "wbsId":12101, "projectId":12102, "originalStartDate":"2023-03-19T23:02:15", "originalFinishDate":"2023-06-19T23:02:15", "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Work_Package_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Work Package by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a work package using the WBS ID, project ID, work package code, work package name and code values fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "workPackageName":"Create-HVAC-Design", "workPackageCode":"WP10", "wbsId":12101, "projectId":12102, "originalStartDate":"2023-03-19T23:02:15", "originalFinishDate":"2023-06-19T23:02:15", "codeValues":[ { "parentId":89002, "codeTypeCode":"Department", "codeValueCode":"ENG" } ] }, "valueSetFlag":true }, "Create_a_Work_Package_that_includes_Configured_Field_Text":{ "summary":"Create a Work Package that includes Configured Field Text", "description":"Payload to create a work package using the WBS ID, project ID, work package code, work package name, and values for the configured field which include column name and text value.", "value":{ "workPackageName":"Create-HVAC-Design", "workPackageCode":"WP10", "wbsId":12101, "projectId":12102, "originalStartDate":"2023-03-19T23:02:15", "originalFinishDate":"2023-06-19T23:02:15", "configuredFields":[ { "columnName":"Notes", "textValue":"Notes of Work Package" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the Work Package Change Request Service." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkPackage", "$ref":"#/components/schemas/ApiEntityWorkPackage", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workPackage-post", "x-filename-id":"workpackage-post" } }, "/workPackage/{workPackageId}":{ "get":{ "tags":[ "Work Package" ], "summary":"View a Work Package ", "description":"This endpoint returns work packages that meet the following requirements:
        • The object is associated with a work package with an ID value that matches the value of the {workPackageId} path parameter.
        ", "operationId":"/workPackage/{workPackageId}_find_91", "parameters":[ { "name":"workPackageId", "in":"path", "description":"The system-generated identifier of a work package.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested work package does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkPackage", "$ref":"#/components/schemas/ApiEntityWorkPackage", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workPackage-{workPackageId}-get", "x-filename-id":"workpackage-workpackageid-get" }, "delete":{ "tags":[ "Work Package" ], "summary":"Delete a Work Package ", "description":"Send a request to this endpoint to delete a work package. The application object with an ID value that matches the value of the {workPackageId} path parameter will be deleted.", "operationId":"/workPackage/{workPackageId}_delete_71", "parameters":[ { "name":"workPackageId", "in":"path", "description":"The system-generated identifier of a work package.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Work Package Change Request Service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"workPackage-{workPackageId}-delete", "x-filename-id":"workpackage-workpackageid-delete" } }, "/workPackage/project/{projectId}/code/{workPackageCode}":{ "get":{ "tags":[ "Work Package" ], "summary":"View all Work Packages by Project and Code", "description":"This endpoint returns work packages that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        • The object has a code that matches the value of the {workPackageCode} path parameter.
        ", "operationId":"/workPackage/project/{projectId}/code/{workPackageCode}_findByCode_20", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workPackageCode", "in":"path", "description":"The user-specified identifier of a work package.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested work package does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkPackage", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workPackage-project-{projectId}-code-{workPackageCode}-get", "x-filename-id":"workpackage-project-projectid-code-workpackagecode-get" } }, "/workPackage/project/{projectId}/name/{workPackageName}":{ "get":{ "tags":[ "Work Package" ], "summary":"View all Work Packages by Project and Name", "description":"This endpoint returns work packages that meet the following requirements:
        • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
        • The object has a name that matches the value of the {workPackageName} path parameter.
        ", "operationId":"/workPackage/project/{projectId}/name/{workPackageName}_findByName_18", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workPackageName", "in":"path", "description":"The name of a work package.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested work package does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkPackage", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workPackage-project-{projectId}-name-{workPackageName}-get", "x-filename-id":"workpackage-project-projectid-name-workpackagename-get" } }, "/workPackage/project/{projectId}":{ "get":{ "tags":[ "Work Package" ], "summary":"View all Work Packages by Project", "description":"This endpoint returns work packages that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        ", "operationId":"/workPackage/project/{projectId}_findByProject_16", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested work package does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkPackage", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workPackage-project-{projectId}-get", "x-filename-id":"workpackage-project-projectid-get" } }, "/workPackage/project/{projectId}/configuredField/{viewColumnName}/{value}":{ "get":{ "tags":[ "Work Package" ], "summary":"View all Work Packages by Assigned Configured Field Value", "description":"This endpoint returns work packages that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        • The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
        ", "operationId":"/workPackage/project/{projectId}/configuredField/{viewColumnName}/{value}_findByUDFValue_10", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"viewColumnName", "in":"path", "description":"The name of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"value", "in":"path", "description":"The value of a configured field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested work package does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkPackage", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workPackage-project-{projectId}-configuredField-{viewColumnName}-{value}-get", "x-filename-id":"workpackage-project-projectid-configuredfield-viewcolumnname-value-get" } }, "/workPackage/wbs/{wbsId}":{ "get":{ "tags":[ "Work Package" ], "summary":"View all Work Packages by WBS", "description":"This endpoint returns work packages that meet the following requirements:
        • The object is associated with a WBS with an ID value that matches the value of the {wbsId} path parameter.
        ", "operationId":"/workPackage/wbs/{wbsId}_findByWbs", "parameters":[ { "name":"wbsId", "in":"path", "description":"The system-generated identifier of a WBS.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested work package does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkPackage", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workPackage-wbs-{wbsId}-get", "x-filename-id":"workpackage-wbs-wbsid-get" } }, "/workPackage/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}":{ "get":{ "tags":[ "Work Package" ], "summary":"View a Work Package by Assigned Code Value", "description":"This endpoint returns work packages that meet the following requirements:
        • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
        • The object is assigned a code type that matches the value of the {codeTypeId} path parameter with a value that matches the value of the {codeValueCode} path parameter.
        ", "operationId":"/workPackage/project/{projectId}/codeType/{codeTypeId}/codeValue/{codeValueCode}_findWorkPackageByCodeValue", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a code value.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeTypeId", "in":"path", "description":"The system-generated identifier of a code value type.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"codeValueCode", "in":"path", "description":"The user-specified identifier of a code value.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested work package does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkPackage", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workPackage-project-{projectId}-codeType-{codeTypeId}-codeValue-{codeValueCode}-get", "x-filename-id":"workpackage-project-projectid-codetype-codetypeid-codevalue-codevaluecode-get" } }, "/workflow":{ "post":{ "tags":[ "Workflow" ], "summary":"Start a Workflow", "description":"This Endpoint can be used to Start a WorkFlow.", "operationId":"/workflow_startWorkflow", "requestBody":{ "description":"A object to start a workflow.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStartWorkflow", "$ref":"#/components/schemas/ApiEntityStartWorkflow", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input to start a workflow." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityStartWorkflowResponse", "$ref":"#/components/schemas/ApiEntityStartWorkflowResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workflow-post", "x-filename-id":"workflow-post" } }, "/workflowInstance":{ "get":{ "tags":[ "Workflow Instance" ], "summary":"View Workflow Instances", "description":"Send a request to this endpoint to view workflow instances under a workspace.", "operationId":"/workflowInstance_findInstances", "parameters":[ { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"context", "in":"query", "description":"The specific object that the workflow runs against.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workflowConfigurationName", "in":"query", "description":"User defined identifier of a workflow configuration.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkflowInstance", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workflowInstance-get", "x-filename-id":"workflowinstance-get" } }, "/workflowInstance/steps":{ "get":{ "tags":[ "Workflow Instance" ], "summary":"View Workflow Steps", "description":"Send a request to this endpoint to view steps of multiple workflows.", "operationId":"/workflowInstance/steps_findStepInstances", "parameters":[ { "name":"workflowInstanceIds", "in":"query", "description":"Comma separated system defined identifiers of workflow instances.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Response will be in the format of Map<Long, List<ApiEntityStepInstance> which is a map of provided workflowInstanceId as key and the list of its step instances as value. For example:
        {
        \"1\": [{
        \"completedDate\": \"2024-03-01T06:56:01\",
        \"stepName\": \"Start\",
        \"startedDate\": \"2024-03-01T06:56:00\",
        \"workflowInstanceId\": 1,
        \"tasksCompleted\": 0,
        \"context\": \"P1\",
        \"status\": \"FINISHED\",
        \"workflowInstanceName\": \"Project Closeout\"
        },
        {
        \"stepName\": \"Sponsor Decision\",
        \"startedDate\": \"2024-03-01T06:56:33\",
        \"workflowInstanceId\": 1,
        \"tasksCompleted\": 0,
        \"context\": \"P1\",
        \"status\": \"EXECUTING\",
        \"workflowInstanceName\": \"Project Closeout\"
        }],
        \"2\": [{
        \"completedDate\": \"2024-03-01T07:18:49\",
        \"stepName\": \"Start\",
        \"startedDate\": \"2024-03-01T07:18:48\",
        \"workflowInstanceId\": 2,
        \"tasksCompleted\": 1,
        \"context\": \"P1\",
        \"status\": \"FINISHED\",
        \"workflowInstanceName\": \"Project Closeout\"
        },
        {
        \"stepName\": \"Sponsor Decision\",
        \"startedDate\": \"2024-03-01T07:19:13\",
        \"workflowInstanceId\": 2,
        \"tasksCompleted\": 1,
        \"context\": \"P1\",
        \"status\": \"EXECUTING\",
        \"workflowInstanceName\": \"Project Closeout\"
        }]
        }
        API fetches all the Step Instances records based on the given workflowInstanceIds and the given OOTB (filtering, pagination, sorting, record count) query parameters and then groups the results by workflowInstanceIds at the end. OOTB feature is available on all the ApiEntityStepInstance records and users can provide the ApiEntityStepInstance fields (except for those mentioned in Unsupported Fields for Entity Filtering page) as OOTB query params. For example:
        /api/restapi/workflowInstance/steps?workflowInstanceIds=1,2&filters=status=FINISHED&start=0,limit=5

        Sorting will work inside the groups.

        Since the response is in form of a map, user need to follow the hierarchy for projection. In case there are special characters in stepName, please URL encode those characters in standard UTF-8 and then send in the 'select' header. In above response for example, to select 'status' for '1' workflowInstanceId, user should be to providing the following header:'select' =1{status}
        ", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStepInstance", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workflowInstance-steps-get", "x-filename-id":"workflowinstance-steps-get" } }, "/workflowInstance/steps/tasks":{ "get":{ "tags":[ "Workflow Instance" ], "summary":"View Workflow Step Tasks", "description":"Send a request to this endpoint to view tasks under the given steps.", "operationId":"/workflowInstance/steps/tasks_findTaskInstances", "parameters":[ { "name":"workflowInstanceIds", "in":"query", "description":"Comma separated system defined identifiers of workflow instances.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"stepNames", "in":"query", "description":"Comma separated user defined identifiers of workflow steps.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Response will be in the format of Map<Long, Map<String, Map<DateTime, List<ApiEntityStepInstance>>>> which is a map of provided workflowInstanceId as key and value is a map of the step names as keys and their values are a map of start dates and list of their task instances as values.For example:
        {
        \"1\": [{
        \"completedDate\": \"2024-03-01T06:56:01\",
        \"stepName\": \"Start\",
        \"startedDate\": \"2024-03-01T06:56:00\",
        \"workflowInstanceId\": 1,
        \"tasksCompleted\": 0,
        \"context\": \"P1\",
        \"status\": \"FINISHED\",
        \"workflowInstanceName\": \"Project Closeout\"
        },
        {
        \"stepName\": \"Sponsor Decision\",
        \"startedDate\": \"2024-03-01T06:56:33\",
        \"workflowInstanceId\": 1,
        \"tasksCompleted\": 0,
        \"context\": \"P1\",
        \"status\": \"EXECUTING\",
        \"workflowInstanceName\": \"Project Closeout\"
        }],
        \"2\": [{
        \"completedDate\": \"2024-03-01T07:18:49\",
        \"stepName\": \"Start\",
        \"startedDate\": \"2024-03-01T07:18:48\",
        \"workflowInstanceId\": 2,
        \"tasksCompleted\": 1,
        \"context\": \"P1\",
        \"status\": \"FINISHED\",
        \"workflowInstanceName\": \"Project Closeout\"
        },
        {
        \"stepName\": \"Sponsor Decision\",
        \"startedDate\": \"2024-03-01T07:19:13\",
        \"workflowInstanceId\": 2,
        \"tasksCompleted\": 1,
        \"context\": \"P1\",
        \"status\": \"EXECUTING\",
        \"workflowInstanceName\": \"Project Closeout\"
        }]
        }
        API fetches all the Task Instances records based on the given workflowInstanceIds, stepNames and the given OOTB (filtering, pagination, sorting, record count) query parameters and then groups the results by workflowInstanceIds, stepNames & startDates at the end. OOTB feature is available on all the ApiEntityTaskInstance records and users can provide the ApiEntityTaskInstance fields (except for those mentioned in Unsupported Fields for Entity Filtering page) as OOTB query params. For example:
        /api/restapi/workflowInstance/steps/tasks?workflowInstanceIds=1,2&stepNames=Complete Project Details and Checklist&filters=status=FINISHED&start=0,limit=5

        Sorting will work inside the groups.

        Since the response is in form of a map, user need to follow the hierarchy for projection. In case there are special characters in stepName or startDate, please URL encode those characters in standard UTF-8. In above response for example example, to select 'status' for '1' workflowInstanceId, user should be to providing the following header:'select' = 1{Complete Project Details and Checklist{2024-03-01T06:56:02%2E000Z{status}}}
        ", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityTaskInstance", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workflowInstance-steps-tasks-get", "x-filename-id":"workflowinstance-steps-tasks-get" } }, "/workflowInstance/workflowConfiguration":{ "get":{ "tags":[ "Workflow Instance" ], "summary":"View Workflow Configuration Names", "description":"Send a request to this endpoint to view workflow configuration names under the given workspaces.", "operationId":"/workflowInstance/workflowConfiguration_getWorkflowCOnfigurationNames", "parameters":[ { "name":"workspaceIds", "in":"query", "description":"Comma separated list of system defined identifiers of workspaces.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCodes", "in":"query", "description":"Comma separated list of user defined identifiers of workspaces.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Response will be in the format of two maps: configurationGroupedByWorkspaceId and configurationGroupedByWorkspaceCode. As the name suggests, first field maps the given workspaceIds to list of workflow configuration names present in it and the later one maps the given workspace codes to the list of workflow configuration names present it. For example:
        {
        \"configurationGroupedByWorkspaceId\": {
        \"4001\": [
        \"Configutation 1\",
        \"Configutation 2\"
        ]
        },
        \"configurationGroupedByWorkspaceCode\": {
        \"Workspace Code\": [
        \"Configuration 3\",
        \"Configuration 4\"
        ]
        }
        }
        Projection, pagination & record count will be the supported OOTB features.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkflowConfiguration", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workflowInstance-workflowConfiguration-get", "x-filename-id":"workflowinstance-workflowconfiguration-get" } }, "/workspace/assignUser":{ "post":{ "tags":[ "Workspace" ], "summary":"Assign Permission Profiles To User", "description":"Use this endpoint to assign workspace permission profiles to multiple user.", "operationId":"/workspace/assignUser_assignUser_7", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user to group assignment/removal sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with workspace and user profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceUserPermissions", "$ref":"#/components/schemas/ApiEntityWorkspaceUserPermissions", "exampleSetFlag":false }, "examples":{ "Assign_Workspace_Permission_Profiles_to_Multiple_Users_Using_Codes":{ "summary":"Assign Workspace Permission Profiles to Multiple Users Using Codes", "description":"Payload to assign workspace permission to multiple users using workspace code, profiles such as user name, workspace profile ID, file profile ID, project profile ID, custom log profile ID, program profile ID, portfolio profile ID, idea profile ID, and report profile ID.", "value":{ "workspaceCode":"Civil_Lines_Project", "profiles":[ { "userName":"Adams@example.com", "workspaceProfileId":"12", "projectProfileId":"3", "fileProfileId":"6", "customLogProfileId":"9", "reportProfileId":"7", "programProfileId":"8101", "portfolioProfileId":"4", "ideaProfileId":"8" }, { "userName":"Baker@example.com", "workspaceProfileId":"12", "projectProfileId":"3", "fileProfileId":"6", "customLogProfileId":"9", "reportProfileId":"7", "programProfileId":"8101", "portfolioProfileId":"4", "ideaProfileId":"8" } ] }, "valueSetFlag":true }, "Assign_Workspace_Permission_Profiles_to_Multiple_Users_Using_IDs":{ "summary":"Assign Workspace Permission Profiles to Multiple Users Using IDs", "description":"Payload to assign workspace permission to multiple users using mandatory fields such as workspace ID, user name, and workspace profile ID.", "value":{ "workspaceId":1739401, "profiles":[ { "userName":"Adams@example.com", "workspaceProfileId":"12" }, { "userName":"Baker@example.com", "workspaceProfileId":"12" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityWorkspaceUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-assignUser-post", "x-filename-id":"workspace-assignuser-post" } }, "/workspace/assignUserGroup":{ "post":{ "tags":[ "Workspace" ], "summary":"Assign Permission Profiles To User Group", "description":"Use this endpoint to assign workspace permission profiles to multiple user groups.", "operationId":"/workspace/assignUserGroup_assignUserGroup_1", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user to group assignment/removal sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with workspace and user group profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceUserGroupPermissionInput", "$ref":"#/components/schemas/ApiEntityWorkspaceUserGroupPermissionInput", "exampleSetFlag":false }, "examples":{ "Assign_Workspace_Permission_Profiles_to_Multiple_User_Groups_Using_Code":{ "summary":"Assign Workspace Permission Profiles to Multiple User Groups Using Code", "description":"Payload to assign workspace permission profiles to multiple user groups using workspace code, and profiles.", "value":{ "workspaceCode":"Deep_ws", "profiles":[ { "userGroupId":6301, "workspaceProfileId":2, "reportProfileId":17, "projectProfileId":3, "portfolioProfileId":39, "programProfileId":8102, "fileProfileId":36, "customLogProfileId":19, "ideaProfileId":18 }, { "userGroupId":20389, "workspaceProfileId":31, "reportProfileId":17, "projectProfileId":3, "portfolioProfileId":39, "programProfileId":8102, "fileProfileId":36, "customLogProfileId":19, "ideaProfileId":8 } ] }, "valueSetFlag":true }, "Assign_Workspace_Permission_Profiles_to_Multiple_User_Groups_Using_ID":{ "summary":"Assign Workspace Permission Profiles to Multiple User Groups Using ID", "description":"Payload to assign workspace permission profiles to multiple user groups using workspace ID, and profiles.", "value":{ "workspaceId":2344, "profiles":[ { "userGroupId":6301, "workspaceProfileId":2, "reportProfileId":17, "projectProfileId":3, "portfolioProfileId":39, "programProfileId":8102, "fileProfileId":36, "customLogProfileId":19, "ideaProfileId":18 }, { "userGroupId":20389, "workspaceProfileId":31, "reportProfileId":17, "projectProfileId":3, "portfolioProfileId":39, "programProfileId":8102, "fileProfileId":36, "customLogProfileId":19, "ideaProfileId":8 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityWorkspaceUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-assignUserGroup-post", "x-filename-id":"workspace-assignusergroup-post" } }, "/workspace/assignUsersToGroup":{ "post":{ "tags":[ "Workspace" ], "summary":"Assign Users To User Group", "description":"Use this endpoint to assign users to user group at given workspace.", "operationId":"/workspace/assignUsersToGroup_assignUsersToGroup_1", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user to group assignment/removal sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User group input with workspace and user details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceUserGroupAssignmentInput", "$ref":"#/components/schemas/ApiEntityWorkspaceUserGroupAssignmentInput", "exampleSetFlag":false }, "examples":{ "Assign_User_To_User_Group_At_Workspace_Using_Code":{ "summary":"Assign User To User Group At Workspace Using Code", "description":"Payload to assign user to user group at workspace by using workspace code, user group ID, and user names.", "value":[ { "workspaceCode":"Test", "userGroupId":454701, "userNames":[ "Adams@example.com", "Baker@example.com" ] } ], "valueSetFlag":true }, "Assign_User_To_User_Group_At _Workspace_Using_IDs":{ "summary":"Assign User To User Group At Workspace Using IDs", "description":"Payload to assign user to user group at workspace by using workspace ID, user group ID, and user names.", "value":[ { "workspaceId":"726701", "userGroupId":454701, "userNames":[ "Adams@example.com", "Baker@example.com" ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityWorkspaceUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-assignUsersToGroup-post", "x-filename-id":"workspace-assignuserstogroup-post" } }, "/workspace":{ "get":{ "tags":[ "Workspace" ], "summary":"View all Workspaces", "description":"This endpoint returns all workspaces.", "operationId":"/workspace_loadAllWorkSpace", "responses":{ "404":{ "description":"Error loading all {workspaces}." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspace", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-get", "x-filename-id":"workspace-get" }, "put":{ "tags":[ "Workspace" ], "summary":"Update a Workspace", "description":"Send a request to this endpoint to update a workspace.", "operationId":"/workspace_update_74", "requestBody":{ "description":"A workspace object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceInput", "$ref":"#/components/schemas/ApiEntityWorkspaceInput", "exampleSetFlag":false }, "examples":{ "Update_a_Workspace_Using_Workspace ID":{ "summary":"Update a Workspace Using Workspace ID", "description":"Payload to update the workspace code and name using the workspace ID.", "value":{ "workspaceId":101, "workspaceCode":"North America", "workspaceName":"North America" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"workspace-put", "x-filename-id":"workspace-put" }, "post":{ "tags":[ "Workspace" ], "summary":"Create a Workspace", "description":"Send a request to this endpoint to create a workspace.", "operationId":"/workspace_create_79", "requestBody":{ "description":"A workspace object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceInput", "$ref":"#/components/schemas/ApiEntityWorkspaceInput", "exampleSetFlag":false }, "examples":{ "Create_a_Workspace":{ "summary":"Create a Workspace", "description":"Payload to create a workspace using the parent ID, workspace code, and workspace name.", "value":{ "parentId":102, "workspaceCode":"North America", "workspaceName":"North America" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspace", "$ref":"#/components/schemas/ApiEntityWorkspace", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-post", "x-filename-id":"workspace-post" } }, "/workspace/batch":{ "put":{ "tags":[ "Workspace" ], "summary":"Batch Update Workspaces", "description":"Send a request to this endpoint to update one or more workspaces.", "operationId":"/workspace/batch_updateBatch_57", "requestBody":{ "description":"One or more workspace objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Workspaces_Using_Workspace IDs":{ "summary":"Batch Update Workspaces Using Workspace IDs", "description":"Payload to update the workspace code and name of one or more workspaces using the workspace IDs.", "value":[ { "workspaceId":10001, "workspaceCode":"North America", "workspaceName":"North America - New York" }, { "workspaceId":10002, "workspaceCode":"Asia", "workspaceName":"Asia - India" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"workspace-batch-put", "x-filename-id":"workspace-batch-put" }, "post":{ "tags":[ "Workspace" ], "summary":"Batch Create Workspaces", "description":"Send a request to this endpoint to create one or more workspaces.", "operationId":"/workspace/batch_createBatch_59", "requestBody":{ "description":"One or more workspace objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Workspaces":{ "summary":"Batch Create Workspaces", "description":"Payload to create one or more workspaces using the parent ID, workspace code, and workspace name.", "value":[ { "parentId":102, "workspaceCode":"North America", "workspaceName":"North America" }, { "parentId":102, "workspaceCode":"Asia", "workspaceName":"Asia" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspace", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-batch-post", "x-filename-id":"workspace-batch-post" }, "delete":{ "tags":[ "Workspace" ], "summary":"Batch Delete Workspaces", "description":"Send a request to this endpoint to delete one or more workspaces.", "operationId":"/workspace/batch_deleteBatch_55", "requestBody":{ "description":"One or more system-generated identifiers of workspaces.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"workspace-batch-delete", "x-filename-id":"workspace-batch-delete" } }, "/workspace/{workspaceId}":{ "get":{ "tags":[ "Workspace" ], "summary":"View a Workspace", "description":"This endpoint returns workspaces that meet the following requirements:
        • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        ", "operationId":"/workspace/{workspaceId}_find_92", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested workspace does not exist or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspace", "$ref":"#/components/schemas/ApiEntityWorkspace", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-{workspaceId}-get", "x-filename-id":"workspace-workspaceid-get" }, "delete":{ "tags":[ "Workspace" ], "summary":"Delete a Workspace", "description":"Send a request to this endpoint to delete a workspace. The application object with an ID value that matches the value of the {workspaceId} path parameter will be deleted.", "operationId":"/workspace/{workspaceId}_delete_72", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"workspace-{workspaceId}-delete", "x-filename-id":"workspace-workspaceid-delete" } }, "/workspace/code/{workspaceCode}":{ "get":{ "tags":[ "Workspace" ], "summary":"View a Workspace by Code", "description":"This endpoint returns workspaces that meet the following requirements:
        • The object is associated with a workspace with a code value that matches the value of the {workspaceCode} path parameter.
        ", "operationId":"/workspace/code/{workspaceCode}_findByName_19", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The name of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested workspace does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspace", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-code-{workspaceCode}-get", "x-filename-id":"workspace-code-workspacecode-get" } }, "/workspace/children/{workspaceId}":{ "get":{ "tags":[ "Workspace" ], "summary":"View Child Workspaces ", "description":"This endpoint returns child workspaces of workspaces that meet the following requirements:
        • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        ", "operationId":"/workspace/children/{workspaceId}_findDirectChildWorkspaces", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Error loading root workspace." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspace", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-children-{workspaceId}-get", "x-filename-id":"workspace-children-workspaceid-get" } }, "/workspace/root":{ "get":{ "tags":[ "Workspace" ], "summary":"View the Root Workspace", "description":"This endpoint returns the root workspace.", "operationId":"/workspace/root_findRoot", "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspace", "$ref":"#/components/schemas/ApiEntityWorkspace", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-root-get", "x-filename-id":"workspace-root-get" } }, "/workspace/image/{workspaceId}":{ "get":{ "tags":[ "Workspace" ], "summary":"View a Workspace Image", "description":"This endpoint returns workspace images that meet the following requirements:
        • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        .", "operationId":"/workspace/image/{workspaceId}_findWorkspaceImage", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested workspace image data does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceImage", "$ref":"#/components/schemas/ApiEntityWorkspaceImage", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-image-{workspaceId}-get", "x-filename-id":"workspace-image-workspaceid-get" } }, "/workspace/{workspaceId}/childrenHierarchy":{ "get":{ "tags":[ "Workspace" ], "summary":"View All Child Workspaces in a Workspace Hierarchy ", "description":"This endpoint returns children of workspaces that meet the following requirements:
        • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        ", "operationId":"/workspace/{workspaceId}/childrenHierarchy_getChildrenHierarchy_3", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested workspace does not exist or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspace", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-{workspaceId}-childrenHierarchy-get", "x-filename-id":"workspace-workspaceid-childrenhierarchy-get" } }, "/workspace/currencyOfRecord":{ "get":{ "tags":[ "Workspace" ], "summary":"View Currency Of Record for a Workspace", "description":"Send a request to this endpoint to view the currency of record and the exchange rate for a specified workspace given by workspaceId or workspaceCode as a query parameter.", "operationId":"/workspace/currencyOfRecord_getCurrencyOfRecord", "parameters":[ { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid input." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCurrencyOfRecord", "$ref":"#/components/schemas/ApiEntityCurrencyOfRecord", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-currencyOfRecord-get", "x-filename-id":"workspace-currencyofrecord-get" } }, "/workspace/permissionSets":{ "get":{ "tags":[ "Workspace" ], "summary":"View Available Permission Sets for Workspace", "description":"Send a request to this endpoint to view the available permission sets for the provided workspace.", "operationId":"/workspace/permissionSets_getPermissionSets_7", "parameters":[ { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Error loading permission sets in the given workspace." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPermissionSets", "$ref":"#/components/schemas/ApiEntityPermissionSets", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-permissionSets-get", "x-filename-id":"workspace-permissionsets-get" } }, "/workspace/userGroups/permissionSets":{ "get":{ "tags":[ "Workspace" ], "summary":"View Permission Sets and Users Assigned to User Group for Workspace", "description":"Send a request to this endpoint to view permission sets and users assigned to a user group at the provided workspace.", "operationId":"/workspace/userGroups/permissionSets_getUserGroupPermissionSets_1", "parameters":[ { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Error loading permission sets and users assigned to a user group in the given workspace." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUserGroupsPermissionAssignments", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-userGroups-permissionSets-get", "x-filename-id":"workspace-usergroups-permissionsets-get" } }, "/workspace/userGroups":{ "get":{ "tags":[ "Workspace" ], "summary":"View User Groups for Workspace", "description":"Send a request to this endpoint to view the user groups accessible for the provided workspace.", "operationId":"/workspace/userGroups_getUserGroups_1", "parameters":[ { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"inheritedUsers", "in":"query", "description":"Enabling this boolean flag will include all inherited users assigned to the user groups.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "responses":{ "404":{ "description":"Error loading user groups in the given workspace." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityUserGroups", "$ref":"#/components/schemas/ApiEntityUserGroups", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-userGroups-get", "x-filename-id":"workspace-usergroups-get" } }, "/workspace/users/permissionSets":{ "get":{ "tags":[ "Workspace" ], "summary":"View Permission Sets assigned to all users at Workspace", "description":"Send a request to this endpoint to view the permission sets assigned to all the users at the provided workspace.", "operationId":"/workspace/users/permissionSets_getUserPermissionSets_1", "parameters":[ { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"Error loading permission sets assigned to all users in the given workspace." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUserPermissionAssignments", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-users-permissionSets-get", "x-filename-id":"workspace-users-permissionsets-get" } }, "/workspace/removeUserGroups":{ "post":{ "tags":[ "Workspace" ], "summary":"Remove User Groups Assigned to a Workspace", "description":"Send a request to this endpoint to remove user groups from a workspace.", "operationId":"/workspace/removeUserGroups_removeUserGroups", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user group removal sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"Remove user group from input.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRemoveWorkspaceUserGroupPermissions", "$ref":"#/components/schemas/ApiEntityRemoveWorkspaceUserGroupPermissions", "exampleSetFlag":false }, "examples":{ "Remove_User_Groups_Assigned_to_a_Workspace":{ "summary":"Remove User Groups Assigned to a Workspace", "description":"Payload to remove user groups from a workspace by using the workspace ID and user group IDs.", "value":{ "workspaceId":4301, "userGroupIds":[ "101", "102" ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRemoveWorkspaceUserGroupPermissionsResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-removeUserGroups-post", "x-filename-id":"workspace-removeusergroups-post" } }, "/workspace/removeUsers":{ "post":{ "tags":[ "Workspace" ], "summary":"Remove Users Assigned to a Workspace", "description":"Send a request to this endpoint to remove users from a workspace.", "operationId":"/workspace/removeUsers_removeUsers_4", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user removal sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"Remove user from input.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityRemoveWorkspaceUserPermissions", "$ref":"#/components/schemas/ApiEntityRemoveWorkspaceUserPermissions", "exampleSetFlag":false }, "examples":{ "Remove_Users_Assigned_to_a_Workspace":{ "summary":"Remove Users Assigned to a Workspace", "description":"Payload to remove users assigned to a workspace by using the workspace code, project code, and user name.", "value":{ "workspaceCode":"PROD", "userNames":[ "Adams@example.com", "Baker@example.com" ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRemoveWorkspaceUserPermissionsResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-removeUsers-post", "x-filename-id":"workspace-removeusers-post" } }, "/workspace/removeUsersFromGroup":{ "post":{ "tags":[ "Workspace" ], "summary":"Remove User From User Group", "description":"Use this endpoint to remove users from user group at given workspace.", "operationId":"/workspace/removeUsersFromGroup_removeUsersFromGroup_1", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred while processing any user to group assignment/removal sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User group input with workspace and user details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceUserGroupAssignmentInput", "$ref":"#/components/schemas/ApiEntityWorkspaceUserGroupAssignmentInput", "exampleSetFlag":false }, "examples":{ "Remove_User_From_User_Group_using_Workspce_ID":{ "summary":"Remove User From User Group using Workspce ID", "description":"Payload to remove a user from a user group in a workspace by using the workspace ID, user group ID, and user name.", "value":{ "workspaceId":4301, "userGroupId":6301, "userNames":[ "Baker@example.com" ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkspaceUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityWorkspaceUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-removeUsersFromGroup-post", "x-filename-id":"workspace-removeusersfromgroup-post" } }, "/workspace/syncBatch":{ "post":{ "tags":[ "Workspace" ], "summary":"Batch Sync Workspaces", "description":"Send a request to this endpoint to create or update one or more workspaces.", "operationId":"/workspace/syncBatch_syncBatch_61", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any workspace sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more workspace objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Workspace_Using_Parent_Workspace_Code":{ "summary":"Create or Update a Workspace Using Parent Workspace Code", "description":"Payload to create or update a workspace using the parent workspace code, workspace code, and workspace name.", "value":[ { "parentWorkspaceCode":"America", "workspaceCode":"North America", "workspaceName":"North America" } ], "valueSetFlag":true }, "Create_or_Update_a_Workspace_Using_Parent_ID":{ "summary":"Create or Update a Workspace Using Parent ID", "description":"Payload to create or update a workspace using the parent ID, workspace code, and workspace name.", "value":[ { "parentId":102, "workspaceCode":"North America", "workspaceName":"North America" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workspace-syncBatch-post", "x-filename-id":"workspace-syncbatch-post" } }, "/portfolioProject/{capitalPortfolioProjectId}":{ "get":{ "tags":[ "Portfolio Project" ], "summary":"View a Portfolio Project ", "description":"This endpoint returns a portfolio project that meet the following requirements:
        • The object has an ID that matches the value of the {capitalPortfolioProjectId} path parameter.
        Portfolio projects are references to projects that belong to a portfolio.", "operationId":"/portfolioProject/{capitalPortfolioProjectId}_find_93", "parameters":[ { "name":"capitalPortfolioProjectId", "in":"path", "description":"The unique identifier of a portfolio project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio project does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioProject", "$ref":"#/components/schemas/ApiEntityPortfolioProject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioProject-{capitalPortfolioProjectId}-get", "x-filename-id":"portfolioproject-capitalportfolioprojectid-get" } }, "/portfolioProject/portfolio/{capitalPortfolioId}":{ "get":{ "tags":[ "Portfolio Project" ], "summary":"View Portfolio Projects by Portfolio ", "description":"This endpoint returns a portofolio project that meet the following requirements:
        • The object is associated with a portfolio with an ID value that matches the value of the {capitalPortfolioId} path parameter.
        Portfolio projects are references to projects that belong to a portfolio.", "operationId":"/portfolioProject/portfolio/{capitalPortfolioId}_getCapitalPortfolioProjectByPortfolioId", "parameters":[ { "name":"capitalPortfolioId", "in":"path", "description":"The system-generated identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio project does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioProject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioProject-portfolio-{capitalPortfolioId}-get", "x-filename-id":"portfolioproject-portfolio-capitalportfolioid-get" } }, "/customLogItem":{ "put":{ "tags":[ "Custom Log Item" ], "summary":"Update a Custom Log Item", "description":"Send a request to this endpoint to update a custom log item. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/customLogItem_update_75", "requestBody":{ "description":"A custom log item object. This object must conform to the ApiEntityCustomLogItem schema.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogItemInput", "$ref":"#/components/schemas/ApiEntityCustomLogItemInput", "exampleSetFlag":false }, "examples":{ "Update_a_Custom_Log_Item_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Custom Log Item by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update a custom log item using the custom log item ID and codeValues fields such as code value code and code type code, and parent ID of the parent code value.", "value":{ "customLogItemId":4001, "codeValues":[ { "parentId":298203, "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_Custom_Log_Item_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Custom Log Item by Assigning Code Values Using IDs", "description":"Payload to update a custom log item using the custom log item ID and codeValues fields such as code value code and code type code.", "value":{ "customLogItemId":4001, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Custom_Log_Item_Using_Custom_Log_Item_ID":{ "summary":"Update a Custom Log Item Using Custom Log Item ID", "description":"Payload to update the due date of a custom log item using the custom log item ID.", "value":{ "customLogItemId":4001, "dueDate":"2022-03-20T00:00:00" }, "valueSetFlag":true }, "Update_a_Custom_Log_Item_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Custom Log Item by Assigning Multiple Code Values Using IDs", "description":"Payload to update a custom log item using the custom log item ID and codeValues fields such as code value code and code type code.", "value":{ "customLogItemId":4001, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Update_a_Custom_Log_Item_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Custom Log Item by Assigning Code Values Using Codes", "description":"Payload to update a custom log item using the project code, workspace code, custom log item code, custom log type object name, and codeValues fields such as code value code and code type code.", "value":{ "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "customLogItemCode":"EX01", "customLogTypeObjectName":"Vehicle Rental Log", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"customLogItem-put", "x-filename-id":"customlogitem-put" }, "post":{ "tags":[ "Custom Log Item" ], "summary":"Create a Custom Log Item", "description":"Send a request to this endpoint to create a custom log item. An application object will be created using the JSON data provided in the request body.", "operationId":"/customLogItem_create_80", "requestBody":{ "description":"A custom log item object. This object must conform to the ApiEntityCustomLogItem schema.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogItemInput", "$ref":"#/components/schemas/ApiEntityCustomLogItemInput", "exampleSetFlag":false }, "examples":{ "Create_a_Custom_Log_Item":{ "summary":"Create a Custom Log Item", "description":"Payload to create a custom log item using the project ID, custom log item name, custom log item code, and custom log type object name.", "value":{ "projectId":30101, "customLogsItemName":"Excavator", "customLogItemCode":"EX01", "customLogTypeObjectName":"Vehicle Rental Log" }, "valueSetFlag":true }, "Create_a_Custom_Log_Item_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Custom Log Item by Assigning Multiple Code Values Using IDs", "description":"Payload to create a custom log item using the project ID, custom log item name, custom log item code, and custom log type object name, and codeValues fields such as code value code and code type code", "value":{ "projectId":2899701, "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX01", "customLogsItemName":"Excavator", "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Custom_Log_Item_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create a Custom Log Item by Assigning Code Values Using IDs", "description":"Payload to create a custom log item using the project ID, custom log item name, custom log item code, and custom log type object name, and codeValues fields such as code value code and code type code", "value":{ "projectId":2899701, "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX01", "customLogsItemName":"Excavator", "codeValues":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Create_a_Custom_Log_Item_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Custom Log Item by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a custom log item using the project code, workspace code, custom log item name, custom log item code, and custom log type object name, and codeValues fields such as code value code and code type code, and parent ID of the parent code value.", "value":{ "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX01", "customLogsItemName":"Excavator", "codeValues":[ { "parentId":298203, "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Create_a_Custom_Log_Item_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Custom Log Item by Assigning Code Values Using Codes", "description":"Payload to create a custom log item using the project code, workspace code, custom log item name, custom log item code, and custom log type object name, and codeValues fields such as code value code and code type code.", "value":{ "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX01", "customLogsItemName":"Excavator", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogItem", "$ref":"#/components/schemas/ApiEntityCustomLogItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogItem-post", "x-filename-id":"customlogitem-post" } }, "/customLogItem/batch":{ "put":{ "tags":[ "Custom Log Item" ], "summary":"Batch Update Custom Log Items", "description":"Send a request to this endpoint to update one or more custom log items. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/customLogItem/batch_updateBatch_58", "requestBody":{ "description":"One or more custom log item objects. Each object must conform to the ApiEntityCustomLogItem schema.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Custom_Log_Items_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Custom Log Items by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update custom log items using the custom log item ID and codeValues fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "customLogItemId":4001, "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, { "customLogItemId":4002, "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] } ], "valueSetFlag":true }, "Batch Update Custom Log Items Using Custom Log Item IDs":{ "summary":"Batch Update Custom Log Items Using Custom Log Item IDs", "description":"Payload to update the due dates of one or more custom log items using the custom log item IDs.", "value":[ { "customLogItemId":4001, "dueDate":"2022-03-10T00:00:00" }, { "customLogItemId":4002, "dueDate":"2022-03-20T00:00:00" } ], "valueSetFlag":true }, "Batch_Update_Custom_Log_Items_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Custom Log Items by Assigning Code Values Using Codes or IDs", "description":"Payload to update custom log items using the custom log item ID and codeValues fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "customLogItemId":4001, "codeValues":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, { "customLogItemId":4002, "codeValues":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"customLogItem-batch-put", "x-filename-id":"customlogitem-batch-put" }, "post":{ "tags":[ "Custom Log Item" ], "summary":"Batch Create Custom Log Items", "description":"Send a request to this endpoint to create one or more custom log items. An application object will be created for each JSON object provided in the request body.", "operationId":"/customLogItem/batch_createBatch_60", "requestBody":{ "description":"One or more custom log item objects. Each object must conform to the ApiEntityCustomLogItem schema.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Custom_Log_Items_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Custom Log Items by Assigning Code Values Using Codes", "description":"Payload to create custom log items using the project code, workspace code, custom log item name, custom log item code, and custom log type object name, and codeValues fields such as code value code and code type code.", "value":[ { "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX01", "customLogsItemName":"Excavator", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ] }, { "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX02", "customLogsItemName":"Loader", "codeValues":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ] } ], "valueSetFlag":true }, "Batch_Create_Custom_Log_Items":{ "summary":"Batch Create Custom Log Items", "description":"Payload to create one or more custom log items using the project IDs, custom log item names, custom log item codes, and type object names.", "value":[ { "projectId":30101, "customLogsItemName":"Excavator", "customLogItemCode":"EX01", "customLogTypeObjectName":"Vehicle Rental Log" }, { "projectId":30101, "customLogsItemName":"Loader", "customLogItemCode":"EX01", "customLogTypeObjectName":"Vehicle Rental Log" } ], "valueSetFlag":true }, "Batch_Create_Custom_Log_Items_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Custom Log Items by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create custom log items using the project code, workspace code, custom log item name, custom log item code, and custom log type object name, and codeValues fields such as code value code and code type code, and parent ID of the parent code value.", "value":[ { "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX01", "customLogsItemName":"Excavator", "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, { "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX02", "customLogsItemName":"Loader", "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogItem-batch-post", "x-filename-id":"customlogitem-batch-post" }, "delete":{ "tags":[ "Custom Log Item" ], "summary":"Batch Delete Custom Log Items", "description":"Send a request to this endpoint to delete one or more custom log items. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/customLogItem/batch_deleteBatch_56", "requestBody":{ "description":"One or more system-generated identifiers of custom log items.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"customLogItem-batch-delete", "x-filename-id":"customlogitem-batch-delete" } }, "/customLogItem/{customLogItemId}":{ "get":{ "tags":[ "Custom Log Item" ], "summary":"View a Custom Log Item", "description":"This endpoint returns custom log items that meet the following requirements:
        • The object has an ID that matches the value of the {customLogItemId} path parameter.
        ", "operationId":"/customLogItem/{customLogItemId}_find_94", "parameters":[ { "name":"customLogItemId", "in":"path", "description":"The system-generated identifier of a custom log item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogItem", "$ref":"#/components/schemas/ApiEntityCustomLogItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogItem-{customLogItemId}-get", "x-filename-id":"customlogitem-customlogitemid-get" }, "delete":{ "tags":[ "Custom Log Item" ], "summary":"Delete a Custom Log Item", "description":"Send a request to this endpoint to delete a custom log item. The application object with an ID value that matches the value of the {customLogItemId} path parameter will be deleted.", "operationId":"/customLogItem/{customLogItemId}_delete_73", "parameters":[ { "name":"customLogItemId", "in":"path", "description":"The system-generated identifier of a custom log item.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"customLogItem-{customLogItemId}-delete", "x-filename-id":"customlogitem-customlogitemid-delete" } }, "/customLogItem/workspace/{workspaceCode}/project/{projectCode}/customLogObject/{customLogTypeObjectName}":{ "get":{ "tags":[ "Custom Log Item" ], "summary":"View a Custom Log Item by Parent", "description":"This endpoint returns custom log items that meet the following requirements:
        • The object is associated with a project with a code value that matches the value of the {projectCode} path parameter.
        • The object is associated with a workspace with a code value that matches the value of the {workspaceCode} path parameter.
        • The object is associated with a custom log type object with a name that matches the value of the {customLogTypeObjectName} path parameter.
        ", "operationId":"/customLogItem/workspace/{workspaceCode}/project/{projectCode}/customLogObject/{customLogTypeObjectName}_getActivitiesByProject_1", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"path", "description":"The user-specified identifier of a project.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"customLogTypeObjectName", "in":"path", "description":"The name of a custom log type object.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogItem", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogItem-workspace-{workspaceCode}-project-{projectCode}-customLogObject-{customLogTypeObjectName}-get", "x-filename-id":"customlogitem-workspace-workspacecode-project-projectcode-customlogobject-customlogtypeobjectname-get" } }, "/customLogItem/workspace/{workspaceCode}/project/{projectCode}/customLogObject/{customLogTypeObjectName}/code/{customLogItemCode}":{ "get":{ "tags":[ "Custom Log Item" ], "summary":"View a Custom Log Item by Parent and Code", "description":"This endpoint returns custom log items that meet the following requirements:
        • The object is associated with a project with a code value that matches the value of the {projectCode} path parameter.
        • The object is associated with a workspace with a code value that matches the value of the {workspaceCode} path parameter.
        • The object is associated with a custom log type object with a name that matches the value of the {customLogTypeObjectName} path parameter.
        • The object has a code that matches the value of the {customLogItemCode} path parameter.
        ", "operationId":"/customLogItem/workspace/{workspaceCode}/project/{projectCode}/customLogObject/{customLogTypeObjectName}/code/{customLogItemCode}_getcustomLogItemByParent", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"path", "description":"The user-specified identifier of a project.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"customLogTypeObjectName", "in":"path", "description":"The name of a custom log type object.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"customLogItemCode", "in":"path", "description":"The user-specified identifier of a custom log item.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested custom log item does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogItem", "$ref":"#/components/schemas/ApiEntityCustomLogItem", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogItem-workspace-{workspaceCode}-project-{projectCode}-customLogObject-{customLogTypeObjectName}-code-{customLogItemCode}-get", "x-filename-id":"customlogitem-workspace-workspacecode-project-projectcode-customlogobject-customlogtypeobjectname-code-customlogitemcode-get" } }, "/customLogItem/syncBatch":{ "post":{ "tags":[ "Custom Log Item" ], "summary":"Batch Sync Custom Log Items", "description":"Send a request to this endpoint to create or update one or more custom log items.", "operationId":"/customLogItem/syncBatch_syncBatch_62", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any custom log items sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more custom log item objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Custom_Log_Items_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create or Update Custom Log Items by Assigning Code Values Using Codes", "description":"Payload to create or update custom log items using the project code, workspace code, custom log item name, custom log item code, custom log type object name, custom log item ID, and codeValues fields such as code value code and code type code.", "value":[ { "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX01", "customLogsItemName":"Excavator", "codeValues":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ] }, { "customLogItemId":4002, "codeValues":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ] } ], "valueSetFlag":true }, "Create_or_Update_Custom_Log_Items_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create or Update Custom Log Items by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create or update custom log items using the project code, workspace code, custom log item name, custom log item code, custom log type object name, custom log item ID, and codeValues fields such as code value code and code type code, and parent ID of the parent code value.", "value":[ { "projectCode":"New Town - City Mall", "workspaceCode":"Asia", "customLogTypeObjectName":"Vehicle Rental Log", "customLogItemCode":"EX01", "customLogsItemName":"Excavator", "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, { "customLogItemId":4002, "codeValues":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] } ], "valueSetFlag":true }, "Create_or_Update_a_Custom_Log_Item":{ "summary":"Create or Update a Custom Log Item", "description":"Payload to create or update a custom log item using the project ID, custom log item name, custom log item code, and custom log type object name.", "value":[ { "projectId":30101, "customLogsItemName":"Excavator", "customLogItemCode":"EX01", "customLogTypeObjectName":"Vehicle Rental Log" } ], "valueSetFlag":true }, "Create_or_Update_a_Custom_Log_Item_Using_Codes":{ "summary":"Create or Update a Custom Log Item Using Codes", "description":"Payload to create or update a custom log item using the project code, workspace code, custom log item name, custom log item code, and custom log type object name.", "value":[ { "projectCode":"New Town - City Mall", "workspaceCode":"North America", "customLogsItemName":"Excavator", "customLogItemCode":"EX01", "customLogTypeObjectName":"Vehicle Rental Log" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogItem-syncBatch-post", "x-filename-id":"customlogitem-syncbatch-post" } }, "/customLogTypeObject/assign":{ "post":{ "tags":[ "Custom Log Type Object" ], "summary":"Assign a Custom Log Type Object to Workspaces, Programs and Projects", "description":"Send a request to this end point to assign a custom log type object created in a workspace to the other workspaces in the hierarchy, projects and programs under the created workspace. ", "operationId":"/customLogTypeObject/assign_assign_1", "requestBody":{ "description":"The request payload for assigning custom log type object to workspaces, projects and programs.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectAssignRequestInput", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectAssignRequestInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectAssignResponse", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectAssignResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-assign-post", "x-filename-id":"customlogtypeobject-assign-post" } }, "/customLogTypeObject/assign/batch":{ "post":{ "tags":[ "Custom Log Type Object" ], "summary":"Batch Assign Custom Log Type Objects to a Workspaces, Programs and Projects", "description":"Send a request to this end point to assign custom log type objects to the other workspaces in their workspace hierarchy, projects and programs under the created workspace.", "operationId":"/customLogTypeObject/assign/batch_assignBatch", "requestBody":{ "description":"The request payload for assigning custom log type objects to workspaces, projects and programs.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectAssignRequestInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectAssignResponse", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectAssignResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-assign-batch-post", "x-filename-id":"customlogtypeobject-assign-batch-post" } }, "/customLogTypeObject/assignUser":{ "post":{ "tags":[ "Custom Log Type Object" ], "summary":"Assign Permission Profiles To User", "description":"Use this endpoint to assign custom log type object permission profiles to multiple user.", "operationId":"/customLogTypeObject/assignUser_assignUser_8", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when validating any user permission profile sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ].", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"User permission input with report and user profile details.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectUserPermissions", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectUserPermissions", "exampleSetFlag":false }, "examples":{ "Assign_Custom_Log_Type_Object_Permission_Profiles_to_Multiple_Users_Using_IDs":{ "summary":"Assign Custom Log Type Object Permission Profiles to Multiple Users Using IDs", "description":"Payload to assign custom log type object permission to multiple users using mandatory fields such as custom log type object ID, user name, and custom log type object profile ID.", "value":{ "customLogTypeObjectId":348001, "profiles":[ { "userName":"manager@stable3a.foo", "customLogTypeObjectProfileId":"9" }, { "userName":"supervisor@stable3a.foo", "customLogTypeObjectProfileId":"9" } ] }, "valueSetFlag":true }, "Assign_Custom_Log_Type_Object_Permission_Profiles_to_Multiple_Users_Using_Codes":{ "summary":"Assign Custom Log Type Object Permission Profiles to Multiple Users Using Codes", "description":"Payload to assign custom log type object permission to multiple users using custom log type object name, scope, scope code, workspace ID, profiles such as user name, idea profile ID, and file profile ID.", "value":{ "customLogTypeObjectName":"Issues Log", "scope":"program", "scopeCode":"Juniper Program", "workspaceId":1098902, "profiles":[ { "userName":"supervisor@stable3a.foo", "customLogTypeObjectProfileId":"9" }, { "userName":"manager@stable3a.foo", "customLogTypeObjectProfileId":"9" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for the custom log type object service." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectUserPermissionsResponse", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectUserPermissionsResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-assignUser-post", "x-filename-id":"customlogtypeobject-assignuser-post" } }, "/customLogTypeObject":{ "put":{ "tags":[ "Custom Log Type Object" ], "summary":"Update a Custom Log Type Object", "description":"Send a request to this endpoint to update a custom log type object. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/customLogTypeObject_update_76", "requestBody":{ "description":"A custom log type object object. This object must conform to the ApiEntityCustomLogTypeObject schema.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectInput", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectInput", "exampleSetFlag":false }, "examples":{ "Update_a_Custom_Log_Type_Object_Using_Custom_Log_Type_Object_ID":{ "summary":"Update a Custom Log Type Object Using Custom Log Type Object ID", "description":"Payload to update the custom log UDF by using the custom log object ID.", "value":{ "customLogTypeObjectId":32002, "customLogUdfs":[ { "columnName":"Potential Impact" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"customLogTypeObject-put", "x-filename-id":"customlogtypeobject-put" }, "post":{ "tags":[ "Custom Log Type Object" ], "summary":"Create a Custom Log Type Object", "description":"Send a request to this endpoint to create a custom log type object. An application object will be created using the JSON data provided in the request body.", "operationId":"/customLogTypeObject_create_81", "requestBody":{ "description":"A custom log type object object. This object must conform to the ApiEntityCustomLogTypeObject schema.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectInput", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectInput", "exampleSetFlag":false }, "examples":{ "Create_a_Custom_Log_Type_Object":{ "summary":"Create a Custom Log Type Object", "description":"Payload to create a custom log type object using the custom log type object name, scope, scope ID, UDFs, and applying the custom objects to the project and program.", "value":{ "customLogTypeObjectName":"Issues Log", "scope":"workspace", "scopeId":28001, "customLogUdfs":[ { "columnName":"Issue Priority" }, { "columnName":"Proposed Resolution" } ], "customLogTypeCodeTypes":[ { "codeTypeCode":"Issue Status" } ], "appliesTo":[ { "entityType":"PROGRAM" }, { "entityType":"PROJECT" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObject", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-post", "x-filename-id":"customlogtypeobject-post" } }, "/customLogTypeObject/batch":{ "put":{ "tags":[ "Custom Log Type Object" ], "summary":"Batch Update Custom Log Type Objects", "description":"Send a request to this endpoint to update custom log type objects. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/customLogTypeObject/batch_updateBatch_59", "requestBody":{ "description":"One or more custom log type object objects. Each object must conform to the ApiEntityCustomLogTypeObject schema.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Custom_Log_Type_Objects_Using_Custom_Log_Type_Object_IDs":{ "summary":"Batch Update Custom Log Type Objects Using Custom Log Type Object IDs", "description":"Payload to update the custom log UDFs by using the custom log object IDs.", "value":[ { "customLogTypeObjectId":32002, "customLogUdfs":[ { "columnName":"Potential Impact" } ] }, { "customLogTypeObjectId":32004, "customLogUdfs":[ { "columnName":"Meeting Venue" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"customLogTypeObject-batch-put", "x-filename-id":"customlogtypeobject-batch-put" }, "post":{ "tags":[ "Custom Log Type Object" ], "summary":"Batch Create Custom Log Type Objects", "description":"Send a request to this endpoint to create custom log type objects. An application object will be created for each JSON object provided in the request body.", "operationId":"/customLogTypeObject/batch_createBatch_61", "requestBody":{ "description":"One or more custom log type object objects. Each object must conform to the ApiEntityCustomLogTypeObject schema.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Custom_Log_Type_Objects":{ "summary":"Batch Create Custom Log Type Objects", "description":"Payload to create one or more custom log type objects using the custom log type object names, scopes, scope IDs, UDFs, and applying the custom objects to the project and program.", "value":[ { "customLogTypeObjectName":"Issues Log", "scope":"workspace", "scopeId":28001, "customLogUdfs":[ { "columnName":"Issue Priority" }, { "columnName":"Proposed Resolution" } ], "appliesTo":[ { "entityType":"PROGRAM" }, { "entityType":"PROJECT" } ] }, { "customLogTypeObjectName":"Meeting Minutes", "scope":"workspace", "scopeId":28001, "customLogUdfs":[ { "columnName":"Attendees" }, { "columnName":"Agenda Attached?" } ], "appliesTo":[ { "entityType":"PROGRAM" }, { "entityType":"PROJECT" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-batch-post", "x-filename-id":"customlogtypeobject-batch-post" }, "delete":{ "tags":[ "Custom Log Type Object" ], "summary":"Batch Delete Custom Log Type Objects", "description":"Send a request to this endpoint to delete custom log type objects. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/customLogTypeObject/batch_deleteBatch_57", "requestBody":{ "description":"One or more system-generated identifiers of custom log type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"customLogTypeObject-batch-delete", "x-filename-id":"customlogtypeobject-batch-delete" } }, "/customLogTypeObject/{customLogTypeObjectId}":{ "get":{ "tags":[ "Custom Log Type Object" ], "summary":"View a Custom Log Type Object", "description":"This endpoint returns custom log type objects that meet the following requirements:
        • The object has an ID that matches the value of the {customLogTypeObjectId} path parameter.
        ", "operationId":"/customLogTypeObject/{customLogTypeObjectId}_find_95", "parameters":[ { "name":"customLogTypeObjectId", "in":"path", "description":"The system-generated identifier of a custom log type object.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObject", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-{customLogTypeObjectId}-get", "x-filename-id":"customlogtypeobject-customlogtypeobjectid-get" }, "delete":{ "tags":[ "Custom Log Type Object" ], "summary":"Delete a Custom Log Type Object", "description":"Send a request to this endpoint to delete a custom log type object. The application object with an ID value that matches the value of the {customLogTypeObjectId} path parameter will be deleted.", "operationId":"/customLogTypeObject/{customLogTypeObjectId}_delete_74", "parameters":[ { "name":"customLogTypeObjectId", "in":"path", "description":"The system-generated identifier of a custom log type object.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"customLogTypeObject-{customLogTypeObjectId}-delete", "x-filename-id":"customlogtypeobject-customlogtypeobjectid-delete" } }, "/customLogTypeObject/codeTypes/workspace/{workspaceCode}/scope/{scopeCode}/name/{customLogTypeObjectName}":{ "delete":{ "tags":[ "Custom Log Type Object" ], "summary":"Batch Delete Custom Log Type Object Code Types", "description":"Send a request to this endpoint to delete custom log type object code types. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/customLogTypeObject/codeTypes/workspace/{workspaceCode}/scope/{scopeCode}/name/{customLogTypeObjectName}_deleteCodeTypes", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scopeCode", "in":"path", "description":"The user-defined identifier of a reference to another object.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"customLogTypeObjectName", "in":"path", "description":"The name of a custom log type object.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "requestBody":{ "description":"The codes of code types associated with a custom log type object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"customLogTypeObject-codeTypes-workspace-{workspaceCode}-scope-{scopeCode}-name-{customLogTypeObjectName}-delete", "x-filename-id":"customlogtypeobject-codetypes-workspace-workspacecode-scope-scopecode-name-customlogtypeobjectname-delete" } }, "/customLogTypeObject/udfs/workspace/{workspaceCode}/scope/{scopeCode}/name/{customLogTypeObjectName}":{ "delete":{ "tags":[ "Custom Log Type Object" ], "summary":"Batch Delete Custom Log Type Object Configured Fields", "description":"Send a request to this endpoint to delete custom log type objects configured fields. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/customLogTypeObject/udfs/workspace/{workspaceCode}/scope/{scopeCode}/name/{customLogTypeObjectName}_deleteUdfs", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"scopeCode", "in":"path", "description":"The user-defined identifier of a reference to another object.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"customLogTypeObjectName", "in":"path", "description":"The name of a custom log type object.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "requestBody":{ "description":"The labels of configured fields associated with a custom log type object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"customLogTypeObject-udfs-workspace-{workspaceCode}-scope-{scopeCode}-name-{customLogTypeObjectName}-delete", "x-filename-id":"customlogtypeobject-udfs-workspace-workspacecode-scope-scopecode-name-customlogtypeobjectname-delete" } }, "/customLogTypeObject/permissionSets":{ "get":{ "tags":[ "Custom Log Type Object" ], "summary":"View Available Permission Sets for Custom Log Type Object", "description":"Send a request to this endpoint to view the available permission sets for the provided custom log type object.", "operationId":"/customLogTypeObject/permissionSets_getPermissionSets_8", "parameters":[ { "name":"customLogTypeObjectId", "in":"query", "description":"The system-generated identifier of a custom log type object.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-defined identifier of a workspace.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceId", "in":"query", "description":"The system-generated identifier of a workspace.", "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"customLogTypeObjectName", "in":"query", "description":"The user-defined identifier of a custom log type object.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"The request doesn't contain the proper combination of query parameters." }, "404":{ "description":"The requested custom log type object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPermissionSets", "$ref":"#/components/schemas/ApiEntityPermissionSets", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-permissionSets-get", "x-filename-id":"customlogtypeobject-permissionsets-get" } }, "/customLogTypeObject/byItemCode":{ "get":{ "tags":[ "Custom Log Type Object" ], "summary":"View a Custom Log Type Object by Name and Workspace or Program or Project Codes", "description":"Send a request to this end point to view the custom log type object record created and assigned to the workspace or project or program specified as combination of query parameters used to identify the individual object and having with name specified as path parameter.", "operationId":"/customLogTypeObject/byItemCode_getcustomLogObjectByParentAndNameNew", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-defined identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"The user-defined identifier of a program.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-defined identifier of a project.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"customLogTypeObjectName", "in":"query", "description":"The user-defined identifier of a custom log type object.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"The request doesn't contain the proper combination of query parameters." }, "404":{ "description":"The requested custom log type object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObject", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObject", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-byItemCode-get", "x-filename-id":"customlogtypeobject-byitemcode-get" } }, "/customLogTypeObject/byParent":{ "get":{ "tags":[ "Custom Log Type Object" ], "summary":"View Custom Log Type Objects by Workspace or Program or Project Codes", "description":"Send a request to this end point to view all the custom log type objects created and assigned to the workspace or project or program specified as combination of query parameters used to identify the individual object.", "operationId":"/customLogTypeObject/byParent_getcustomLogObjectByParentNew", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-defined identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"The user-defined identifier of a program.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-defined identifier of a project.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"The request doesn't contain the proper combination of query parameters." }, "404":{ "description":"The requested custom log type object does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-byParent-get", "x-filename-id":"customlogtypeobject-byparent-get" } }, "/customLogTypeObject/program/{programId}":{ "get":{ "tags":[ "Custom Log Type Object" ], "summary":"View Custom Log Type Objects by Program", "description":"Send a request to this end point to view all the custom log type objects created and assigned to the program specified as a path parameter", "operationId":"/customLogTypeObject/program/{programId}_getcustomLogObjectByProgram", "parameters":[ { "name":"programId", "in":"path", "description":"The system-generated identifier of a program.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The given program ID doesn't exist or has been deleted." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-program-{programId}-get", "x-filename-id":"customlogtypeobject-program-programid-get" } }, "/customLogTypeObject/project/{projectId}":{ "get":{ "tags":[ "Custom Log Type Object" ], "summary":"View Custom Log Type Objects by Project", "description":"Send a request to this end point to view all the custom log type objects created and assigned to the project specified as a path parameter", "operationId":"/customLogTypeObject/project/{projectId}_getcustomLogObjectByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The given project ID doesn't exist or has been deleted." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-project-{projectId}-get", "x-filename-id":"customlogtypeobject-project-projectid-get" } }, "/customLogTypeObject/workspace/{workspaceId}":{ "get":{ "tags":[ "Custom Log Type Object" ], "summary":"View Custom Log Type Objects by Workspace", "description":"Send a request to this end point to view all the custom log type objects created and assigned to the workspace specified as a path parameter", "operationId":"/customLogTypeObject/workspace/{workspaceId}_getcustomLogObjectByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The given workspace ID doesn't exist or has been deleted." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObject", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-workspace-{workspaceId}-get", "x-filename-id":"customlogtypeobject-workspace-workspaceid-get" } }, "/customLogTypeObject/syncBatch":{ "post":{ "tags":[ "Custom Log Type Object" ], "summary":"Batch Sync Custom Log Type Objects", "description":"Send a request to this endpoint to create or update one or more custom log type objects.", "operationId":"/customLogTypeObject/syncBatch_syncBatch_63", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any custom log type objects sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more custom log type objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Custom_Log_Type_Object":{ "summary":"Create or Update a Custom Log Type Object", "description":"Payload to create or update a custom log type object using the custom log type object name, scope, scope code, and workspace code.", "value":[ { "scope":"project", "workspaceCode":"North America", "customLogTypeObjectName":"Issue Less Priority", "scopeCode":"New Town - City Mall" } ], "valueSetFlag":true }, "Create_or_Update_a_Custom_Log_Type_Object_Using_Applies_To":{ "summary":"Create or Update a Custom Log Type Object Using Applies To", "description":"Payload to create or update a custom log type object using the custom log type object name, scope, scope ID, UDFs, and applying the custom objects to the project and program.", "value":[ { "customLogTypeObjectName":"Issues Log", "scope":"workspace", "scopeId":28001, "customLogUdfs":[ { "columnName":"Issue Priority" }, { "columnName":"Proposed Resolution" } ], "customLogTypeCodeTypes":[ { "codeTypeCode":"Issue Status" } ], "appliesTo":[ { "entityType":"PROGRAM" }, { "entityType":"PROJECT" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-syncBatch-post", "x-filename-id":"customlogtypeobject-syncbatch-post" } }, "/customLogTypeObject/unassign":{ "delete":{ "tags":[ "Custom Log Type Object" ], "summary":"Unassign a Custom Log Type Object to Workspaces, Programs and Projects", "description":"Send a request to this end point to unassign a custom log type object assigned to the other workspaces in the hierarchy, projects and programs under the created workspace. ", "operationId":"/customLogTypeObject/unassign_unassign", "requestBody":{ "description":"The request payload for unassigning custom log type object to workspaces, projects and programs.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectAssignRequestInput", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectAssignRequestInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectAssignResponse", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectAssignResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-unassign-delete", "x-filename-id":"customlogtypeobject-unassign-delete" } }, "/customLogTypeObject/unassign/batch":{ "delete":{ "tags":[ "Custom Log Type Object" ], "summary":"Batch Unassign Custom Log Type Objects to a Workspaces, Programs and Projects", "description":"Send a request to this end point to unassign custom log type objects assigned to the other workspaces in their workspace hierarchy, projects and programs under the created workspace.", "operationId":"/customLogTypeObject/unassign/batch_unassignBatch", "requestBody":{ "description":"The request payload for unassigning custom log type objects to workspaces, projects and programs.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectAssignRequestInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "200":{ "description":"The object was successfully updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityCustomLogTypeObjectAssignResponse", "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectAssignResponse", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"customLogTypeObject-unassign-batch-delete", "x-filename-id":"customlogtypeobject-unassign-batch-delete" } }, "/entityReference/batch":{ "post":{ "tags":[ "Related Items" ], "summary":"Batch Create References", "description":"Send a request to this endpoint to create one or more references. An application object will be created for each JSON object provided in the request body.", "operationId":"/entityReference/batch_createBatch_62", "requestBody":{ "description":"One or more entity reference objects. Each object must conform to the ApiEntityEntityReference schema.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityEntityReferenceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_References":{ "summary":"Batch Create References", "description":"Payload to create one or more references using the from ID, from type, program code, project code, to ID, to type workspace code, and entity reference ID.", "value":[ { "fromId":4002, "fromType":"IDEA", "programCode":"", "projectCode":"William_Street_Project", "toId":204101, "toType":"PROJECT", "workspaceCode":"Civil_Lines_Project" }, { "fromId":4002, "fromType":"IDEA", "programCode":"", "projectCode":"William_Street_Project", "toId":206101, "toType":"PROJECT", "workspaceCode":"Civil_Lines_Project" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityEntityReference", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"entityReference-batch-post", "x-filename-id":"entityreference-batch-post" }, "delete":{ "tags":[ "Related Items" ], "summary":"Batch Delete References", "description":"Send a request to this endpoint to delete one or more references. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/entityReference/batch_deleteBatch_58", "requestBody":{ "description":"One or more system-generated identifiers of entity references.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"entityReference-batch-delete", "x-filename-id":"entityreference-batch-delete" } }, "/entityReference/{entityReferenceId}":{ "get":{ "tags":[ "Related Items" ], "summary":"View a Reference", "description":"This endpoint returns references that meet the following requirements:
        • The object has an ID that matches the value of the {entityReferenceId} path parameter.
        ", "operationId":"/entityReference/{entityReferenceId}_find_96", "parameters":[ { "name":"entityReferenceId", "in":"path", "description":"The system-generated identifier of an entity reference.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityEntityReference", "$ref":"#/components/schemas/ApiEntityEntityReference", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"entityReference-{entityReferenceId}-get", "x-filename-id":"entityreference-entityreferenceid-get" }, "delete":{ "tags":[ "Related Items" ], "summary":"Delete a Reference", "description":"Send a request to this endpoint to delete a reference. The application object with an ID value that matches the value of the {entityReferenceId} path parameter will be deleted.", "operationId":"/entityReference/{entityReferenceId}_delete_75", "parameters":[ { "name":"entityReferenceId", "in":"path", "description":"The system-generated identifier of an entity reference.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"entityReference-{entityReferenceId}-delete", "x-filename-id":"entityreference-entityreferenceid-delete" } }, "/entityReference/linkableObjectReferences":{ "get":{ "tags":[ "Related Items" ], "summary":"View Objects that Support References", "description":"This endpoint returns objects that may be linked.", "operationId":"/entityReference/linkableObjectReferences_findLinkableObjectReferences", "parameters":[ { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"The user-specified unique identifier of a program.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"recordType", "in":"query", "description":"The type of an object that supports references.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] } }, { "name":"recordCode", "in":"query", "description":"The user-specified identifier of an object associated with a reference.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"recordId", "in":"query", "description":"The system-generated identifier of an object associated with a reference.
        This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"objectType", "in":"query", "description":"The type of the object the reference refers to.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] } } ], "responses":{ "404":{ "description":"The requested reference does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"entityReference-linkableObjectReferences-get", "x-filename-id":"entityreference-linkableobjectreferences-get" } }, "/entityReference/linkedObjectReferences":{ "get":{ "tags":[ "Related Items" ], "summary":"View all References of a Linked Object", "description":"Send a request to this endpoint to view all the linked references by a given object type. ", "operationId":"/entityReference/linkedObjectReferences_findLinkedObjectReferences", "parameters":[ { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"The user-specified unique identifier of a program.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"recordType", "in":"query", "description":"The type of an object that supports references.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] } }, { "name":"recordCode", "in":"query", "description":"The user-specified identifier of an object associated with a reference.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"recordId", "in":"query", "description":"The system-generated identifier of an object associated with a reference.
        This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"objectType", "in":"query", "description":"The type of the object the reference refers to.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] } } ], "responses":{ "404":{ "description":"The requested reference does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"entityReference-linkedObjectReferences-get", "x-filename-id":"entityreference-linkedobjectreferences-get" } }, "/entityReference/linkedReferences":{ "get":{ "tags":[ "Related Items" ], "summary":"View Linked References", "description":"Send a request to this endpoint to view all the linked references.", "operationId":"/entityReference/linkedReferences_findLinkedReferences", "parameters":[ { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"The user-specified unique identifier of a program.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"recordType", "in":"query", "description":"The type of an object that supports references.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] } }, { "name":"recordCode", "in":"query", "description":"The user-specified identifier of an object associated with a reference.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"recordId", "in":"query", "description":"The system-generated identifier of an object associated with a reference.
        This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested reference does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResource", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"entityReference-linkedReferences-get", "x-filename-id":"entityreference-linkedreferences-get" } }, "/entityReference/relatedItems":{ "get":{ "tags":[ "Related Items" ], "summary":"View all Related Items of a Reference", "description":"Send a request to this endpoint to view all the related items of a reference.", "operationId":"/entityReference/relatedItems_findRelatedItems", "parameters":[ { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"programCode", "in":"query", "description":"The user-specified unique identifier of a program.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"recordType", "in":"query", "description":"The type of an object that supports references.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] } }, { "name":"recordCode", "in":"query", "description":"The user-specified identifier of an object associated with a reference.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"recordId", "in":"query", "description":"The system-generated identifier of an object associated with a reference.
        This is a required field.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested reference does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityEntityReference", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"entityReference-relatedItems-get", "x-filename-id":"entityreference-relateditems-get" } }, "/entityReference/link":{ "post":{ "tags":[ "Related Items" ], "summary":"Create a Reference", "description":"Send a request to this endpoint to create a reference. An application object will be created using the JSON data provided in the request body.", "operationId":"/entityReference/link_linkObjects", "requestBody":{ "description":"An entity reference object. This object must conform to the ApiEntityEntityReference schema.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityEntityReferenceInput", "$ref":"#/components/schemas/ApiEntityEntityReferenceInput", "exampleSetFlag":false }, "examples":{ "Create_a_Reference":{ "summary":"Create a Reference", "description":"Payload to create a reference using the from ID, from type, program code, project code, to ID, to type, workspace code, and entity reference ID.", "value":{ "fromId":4002, "fromType":"IDEA", "programCode":"", "projectCode":"William_Street_Project", "toId":206101, "toType":"PROJECT", "workspaceCode":"Civil_Lines_Project" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityEntityReference", "$ref":"#/components/schemas/ApiEntityEntityReference", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"entityReference-link-post", "x-filename-id":"entityreference-link-post" } }, "/entityReference/syncBatch":{ "post":{ "tags":[ "Related Items" ], "summary":"Batch Sync References", "description":"Send a request to this endpoint to create or update one or more entity references.", "operationId":"/entityReference/syncBatch_syncBatch_64", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any entity references sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]# RELATIONSHIP #", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more entity references.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityEntityReferenceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_References":{ "summary":"Batch Create References", "description":"Payload to create or update one or more references using the source and target ID, source and target type, program code, project code, and workspace code.", "value":[ { "fromId":4002, "fromType":"IDEA", "programCode":"", "projectCode":"William_Street_Project", "toId":204101, "toType":"PROJECT", "workspaceCode":"Civil_Lines_Project" }, { "fromId":4002, "fromType":"IDEA", "programCode":"", "projectCode":"William_Street_Project", "toId":206101, "toType":"PROJECT", "workspaceCode":"Civil_Lines_Project" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"entityReference-syncBatch-post", "x-filename-id":"entityreference-syncbatch-post" } }, "/entityReference/unLink":{ "put":{ "tags":[ "Related Items" ], "summary":"Unlink a Reference", "description":"Send a request to this endpoint to unlink a reference.", "operationId":"/entityReference/unLink_unLinkObjects", "requestBody":{ "description":"An entity reference object. This object must conform to the ApiEntityEntityReference schema.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityEntityReferenceInput", "$ref":"#/components/schemas/ApiEntityEntityReferenceInput", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"entityReference-unLink-put", "x-filename-id":"entityreference-unlink-put" } }, "/funds/allocationRuleAssignment":{ "put":{ "tags":[ "Funds" ], "summary":"Assign an Allocation Rule to a Fund", "description":"Send a request to this endpoint to assign an allocation rule to a fund that matches the fields in the query parameters.", "operationId":"/funds/allocationRuleAssignment_addAllocateRulesToFund", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"portfolioName", "in":"query", "description":"Name of the portfolio to be found. This value should not be provided for workspace funds, but it is required for portfolio funds.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"fundCode", "in":"query", "description":"Code of the fund to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"ruleName", "in":"query", "description":"Name of the allocation rule to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"funds-allocationRuleAssignment-put", "x-filename-id":"funds-allocationruleassignment-put" }, "delete":{ "tags":[ "Funds" ], "summary":"Un-assign Allocation Rule from a Fund", "description":"Send a request to this endpoint to un-assign an allocation rule from a fund that matches the fields in the query parameters.", "operationId":"/funds/allocationRuleAssignment_deleteAllocateRulesToFund", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"portfolioName", "in":"query", "description":"Name of the portfolio to be found. This value should not be provided for workspace funds, but it is required for portfolio funds.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"fundCode", "in":"query", "description":"Code of the fund to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"ruleName", "in":"query", "description":"Name of the allocation rule to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"funds-allocationRuleAssignment-delete", "x-filename-id":"funds-allocationruleassignment-delete" } }, "/funds/allocationRuleAssignment/batch":{ "put":{ "tags":[ "Funds" ], "summary":"Assign List of Allocation Rules to a Fund", "description":"Send a request to this endpoint to assign a list of allocation rules to a fund that matches the fields in the query parameters.", "operationId":"/funds/allocationRuleAssignment/batch_addBatchAllocateRulesToFund", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"portfolioName", "in":"query", "description":"Name of the portfolio to be found. This value should not be provided for workspace funds, but it is required for portfolio funds.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"fundCode", "in":"query", "description":"Code of the fund to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "requestBody":{ "description":"List of allocation rules to be found.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"funds-allocationRuleAssignment-batch-put", "x-filename-id":"funds-allocationruleassignment-batch-put" }, "delete":{ "tags":[ "Funds" ], "summary":"Un-assign a list of Allocation Rule from a Fund", "description":"Send a request to this endpoint to un-assign a list of allocation rules to a fund that matches the fields in the query parameters.", "operationId":"/funds/allocationRuleAssignment/batch_deleteBatchAllocateRulesToFund", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"portfolioName", "in":"query", "description":"Name of the portfolio to be found. This value should not be provided for workspace funds, but it is required for portfolio funds.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"fundCode", "in":"query", "description":"Code of the fund to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "requestBody":{ "description":"List of allocation rules to be found.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"funds-allocationRuleAssignment-batch-delete", "x-filename-id":"funds-allocationruleassignment-batch-delete" } }, "/funds/allocationRule":{ "get":{ "tags":[ "Funds" ], "summary":"View Allocation Rules by Fund", "description":"Send a request to this endpoint to view allocation rules that matches the fields in the query parameters.", "operationId":"/funds/allocationRule_findAllocateRulesbyFund", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"portfolioName", "in":"query", "description":"Name of the portfolio to be found. This value should not be provided for workspace funds, but it is required for portfolio funds.", "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"fundCode", "in":"query", "description":"Code of the fund to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNamedFilter", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-allocationRule-get", "x-filename-id":"funds-allocationrule-get" }, "put":{ "tags":[ "Funds" ], "summary":"Update an Allocation Rule", "description":"Send a request to this endpoint to update an allocation rule. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/funds/allocationRule_updateAllocationRule", "requestBody":{ "description":"Allocation rule to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityNamedFilter", "$ref":"#/components/schemas/ApiEntityNamedFilter", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"funds-allocationRule-put", "x-filename-id":"funds-allocationrule-put" }, "post":{ "tags":[ "Funds" ], "summary":"Create an Allocation Rule", "description":"Send a request to this endpoint to create an allocation rule. An application object will be created using the JSON data provided in the request body.", "operationId":"/funds/allocationRule_createAllocationRule", "requestBody":{ "description":"Allocation rule to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityNamedFilter", "$ref":"#/components/schemas/ApiEntityNamedFilter", "exampleSetFlag":false }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityNamedFilter", "$ref":"#/components/schemas/ApiEntityNamedFilter", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-allocationRule-post", "x-filename-id":"funds-allocationrule-post" } }, "/funds/allocationRule/batch":{ "put":{ "tags":[ "Funds" ], "summary":"Batch Update Allocation Rules", "description":"Send a request to this endpoint to update one or more allocation rules. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/funds/allocationRule/batch_updateBatchAllocationRule", "requestBody":{ "description":"Allocation rules to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNamedFilter", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"funds-allocationRule-batch-put", "x-filename-id":"funds-allocationrule-batch-put" }, "post":{ "tags":[ "Funds" ], "summary":"Batch Create Allocation Rules", "description":"Send a request to this endpoint to create one or more allocation rules. An application object will be created for each JSON object provided in the request body.", "operationId":"/funds/allocationRule/batch_createBatchAllocationRule", "requestBody":{ "description":"Allocation rules to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNamedFilter", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNamedFilter", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-allocationRule-batch-post", "x-filename-id":"funds-allocationrule-batch-post" }, "delete":{ "tags":[ "Funds" ], "summary":"Batch Delete Allocation Rules", "description":"Send a request to this endpoint to delete one or more allocation rules. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/funds/allocationRule/batch_deleteBatchAllocationRule", "requestBody":{ "description":"Allocation rules to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"funds-allocationRule-batch-delete", "x-filename-id":"funds-allocationrule-batch-delete" } }, "/funds/portfolio":{ "put":{ "tags":[ "Funds" ], "summary":"Updates a Portfolio Fund", "description":"Send a request to this endpoint to update a portfolio fund.", "operationId":"/funds/portfolio_updatePortfolioFund", "requestBody":{ "description":"Portfolio fund to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundInput", "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "examples":{ "Update_a_Portfolio_Fund_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Portfolio Fund by Assigning Code Values Using Codes", "description":"Payload to update a portfolio fund using the capital portfolio ID, fund code, and codeValuesFund fields such as code value code and code type code.", "value":{ "capitalPortfolioId":1098902, "fundCode":"GRNT", "codeValuesFund":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_Portfolio_Fund_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Portfolio Fund by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update a portfolio fund using the fund ID and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "fundId":740502, "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Update_a_Portfolio_Fund_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Portfolio Fund to Assign a Boolean Configured Field", "description":"Payload to update the total cost of the portfolio fund using the fund code, portfolio ID, and configured field column label and text value.", "value":{ "capitalPortfolioId":10001, "fundCode":"FG", "fundCost":{ "total":10000 }, "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Portfolio_Fund":{ "summary":"Update a Portfolio Fund", "description":"Payload to update the total cost of the portfolio fund using the fund code and portfolio ID.", "value":{ "capitalPortfolioId":10001, "fundCode":"FG", "fundCost":{ "total":10000 } }, "valueSetFlag":true }, "Update_a_Portfolio_Fund_by_Removing_a_Configured_Field":{ "summary":"Update a Portfolio Fund by Removing a Configured Field", "description":"Payload to update the total cost of the portfolio fund using the fund code, portfolio ID, and specifying the action and column label for the configured field to be removed.", "value":{ "capitalPortfolioId":10001, "fundCode":"FG", "fundCost":{ "total":10000 }, "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true }, "Update_a_Portfolio_Fund_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Portfolio Fund by Assigning Code Values Using IDs", "description":"Payload to update a portfolio fund using the fund ID and codeValuesFund fields such as code value ID and code type ID.", "value":{ "fundId":740502, "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Portfolio_Fund_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Portfolio Fund by Assigning Multiple Code Values Using IDs", "description":"Payload to update a portfolio fund using the fund ID and codeValuesFund fields such as code value ID and code type ID.", "value":{ "fundId":740502, "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"funds-portfolio-put", "x-filename-id":"funds-portfolio-put" }, "post":{ "tags":[ "Funds" ], "summary":"Create a Portfolio Fund", "description":"Send a request to this endpoint to create a portfolio fund.", "operationId":"/funds/portfolio_createPortfolioFund", "requestBody":{ "description":"Portfolio fund to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundInput", "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "examples":{ "Create_a_Portfolio_Fund_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Portfolio Fund that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a portfolio fund using the capital portfolio ID, start date, end date, fund code, name, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio Notes" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Portfolio_Fund":{ "summary":"Create a Portfolio Fund", "description":"Payload to create a portfolio fund using the capital portfolio ID, start date, end date, fund code, name, and cost.", "value":{ "capitalPortfolioId":10001, "fundCode":"FG", "fundName":"Federl Grant", "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCost":{ "total":30000 } }, "valueSetFlag":true }, "Create_a_Portfolio_Fund_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Portfolio Fund by Assigning Code Values Using Codes", "description":"Payload to create a portfolio fund using the capital portfolio ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code and code type code.", "value":{ "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Create_a_Portfolio_Fund_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Portfolio Fund by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a portfolio fund using the capital portfolio ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Create_a_Portfolio_Fund_that_includes_Configured_Field_Text":{ "summary":"Create a Portfolio Fund that includes Configured Field Text", "description":"Payload to create a portfolio fund using the capital portfolio ID, start date, end date, fund code, name, and values for the configured field which include column name and text value.", "value":{ "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio Notes" } ] }, "valueSetFlag":true }, "Create_a_Portfolio_Fund_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create a Portfolio Fund by Assigning Code Values Using IDs", "description":"Payload to create a portfolio fund using the capital portfolio ID, start date, end date, fund code, name, and codeValuesFund fields such as code value ID and code type ID.", "value":{ "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Create_a_Portfolio_Fund_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Portfolio Fund by Assigning Multiple Code Values Using IDs", "description":"Payload to create a portfolio fund using the capital portfolio ID, start date, end date, fund code, name, and codeValuesFund fields such as code value ID and code type ID.", "value":{ "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFund", "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-portfolio-post", "x-filename-id":"funds-portfolio-post" } }, "/funds/portfolio/batch":{ "put":{ "tags":[ "Funds" ], "summary":"Update Portfolio Funds", "description":"Send a request to this endpoint to update one or more portfolio funds.", "operationId":"/funds/portfolio/batch_updatePortfolioFundsBatch", "requestBody":{ "description":"Portfolio funds to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Portfolio_Funds":{ "summary":"Batch Update Portfolio Funds", "description":"Payload to update the total costs of one or more portfolio funds using the fund codes and capital portfolio IDs.", "value":[ { "capitalPortfolioId":10001, "fundCode":"FG", "fundCost":{ "total":10000 } }, { "capitalPortfolioId":10001, "fundCode":"BRF", "fundCost":{ "total":15000 } } ], "valueSetFlag":true }, "Batch_Update_Portfolio_Funds_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Portfolio Funds by Assigning Code Values Using Codes or IDs", "description":"Payload to update portfolio funds using the fund ID and codeValuesFund fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "fundId":4101 }, { "codeValuesFund":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "fundId":4102 } ], "valueSetFlag":true }, "Batch_Update_Portfolio_Funds_to_Assign_Configured_Field":{ "summary":"Batch Update Portfolio Funds to Assign Configured Field", "description":"Payload to update portfolio funds using the fund ID and configured field column name, column label, column definition ID, and text value.", "value":[ { "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio Notes" }, { "columnDefinationId":60045, "textValue":"N" } ], "fundId":4101 }, { "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio Notes" }, { "columnDefinationId":60045, "textValue":"N" } ], "fundId":4102 } ], "valueSetFlag":true }, "Batch_Update_Portfolio_Funds_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Portfolio Funds by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update portfolio funds using the fund ID and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "fundId":4101 }, { "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "fundId":4102 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"funds-portfolio-batch-put", "x-filename-id":"funds-portfolio-batch-put" }, "post":{ "tags":[ "Funds" ], "summary":"Batch Create Portfolio Funds", "description":"Send a request to this endpoint to create one or more portfolio funds. An application object will be created for each JSON object provided in the request body.", "operationId":"/funds/portfolio/batch_createPortfolioFundsBatch", "requestBody":{ "description":"Portfolio funds to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Portfolio_Funds":{ "summary":"Batch Create Portfolio Funds", "description":"Payload to create one or more portfolio funds using the project IDs, start dates, end dates, fund codes, names, and costs.", "value":[ { "capitalPortfolioId":10001, "fundCode":"FG", "fundName":"Federl Grant", "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCost":{ "total":30000 } }, { "capitalPortfolioId":10001, "fundCode":"BRF", "fundName":"Bridge Reconstruction Fund", "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCost":{ "total":40000 } } ], "valueSetFlag":true }, "Batch_Create_Portfolio_Funds_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Portfolio Funds by Assigning Code Values Using Codes", "description":"Payload to create portfolio funds using the capital portfolio ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code and code type code.", "value":[ { "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ] }, { "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"PRVT", "fundName":"Private Grant", "codeValuesFund":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ] } ], "valueSetFlag":true }, "Batch_Create_Portfolio_Funds_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Portfolio Funds by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create portfolio funds using the capital portfolio ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, { "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"PRVT", "fundName":"Private Grant", "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] } ], "valueSetFlag":true }, "Batch_Create_Portfolio_Funds_that_include_Configured_Field_Text":{ "summary":"Batch Create Portfolio Funds that include Configured Field Text", "description":"Payload to create portfolio funds using the capital portfolio ID, start date, end date, fund code, name, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio Notes" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "capitalPortfolioId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"PRVT", "fundName":"Private Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Portfolio Notes" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-portfolio-batch-post", "x-filename-id":"funds-portfolio-batch-post" } }, "/funds/project":{ "put":{ "tags":[ "Funds" ], "summary":"Updates a Project Fund", "description":"Send a request to this endpoint to update a project fund.", "operationId":"/funds/project_updateProjectFund", "requestBody":{ "description":"Project fund to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundInput", "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Fund":{ "summary":"Update a Project Fund", "description":"Payload to update the total cost of the project fund using the fund code and project ID.", "value":{ "fundCode":"MF", "projectId":30101, "fundCost":{ "totalProject":20000 } }, "valueSetFlag":true }, "Update_a_Project_Fund_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Project Fund by Assigning Code Values Using Codes", "description":"Payload to update a project fund using the project ID, fund code, and codeValuesFund fields such as code value code and code type code.", "value":{ "projectId":1098902, "fundCode":"GRNT", "codeValuesFund":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_Project_Fund_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Project Fund by Assigning Code Values Using IDs", "description":"Payload to update a project fund using the fund ID and codeValuesFund fields such as code value ID and code type ID.", "value":{ "fundId":740502, "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Update_a_Project_Fund_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Project Fund to Assign a Boolean Configured Field", "description":"Payload to update a project fund using the fund ID and configured field column label and text value.", "value":{ "fundId":740502, "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Project_Fund_by_Removing_a_Configured_Field":{ "summary":"Update a Project Fund by Removing a Configured Field", "description":"Payload to update a project fund using the fund ID and specifying the action and column label for the configured field to be removed.", "value":{ "fundId":740502, "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true }, "Update_a_Project_Fund_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Project Fund by Assigning Multiple Code Values Using IDs", "description":"Payload to update a project fund using the fund ID and codeValuesFund fields such as code value ID and code type ID.", "value":{ "fundId":740502, "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Update_a_Project_Fund_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Project Fund by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update a project fund using the fund ID and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "fundId":740502, "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"funds-project-put", "x-filename-id":"funds-project-put" }, "post":{ "tags":[ "Funds" ], "summary":"Create a Project Fund", "description":"Send a request to this endpoint to create a project fund.", "operationId":"/funds/project_createProjectFund", "requestBody":{ "description":"Project fund to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundInput", "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Fund_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Project Fund by Assigning Multiple Code Values Using IDs", "description":"Payload to create a project fund using the project ID, start date, end date, fund code, name, and codeValuesFund fields such as code value ID and code type ID.", "value":{ "projectId":2571202, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Project_Fund_that_includes_Configured_Field_Text":{ "summary":"Create a Project Fund that includes Configured Field Text", "description":"Payload to create a project fund using the project ID, start date, end date, fund code, name, and values for the configured field which include column name and text value.", "value":{ "projectId":2571202, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Project Fund" } ] }, "valueSetFlag":true }, "Create_a_Project_Fund":{ "summary":"Create a Project Fund", "description":"Payload to create a project fund using the project ID, start date, end date, fund code, name, and cost.", "value":{ "projectId":30101, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"MF", "fundName":"Municipal Funds", "fundCost":{ "totalProject":10000 } }, "valueSetFlag":true }, "Create_a_Project_Fund_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Project Fund by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a project fund using the project ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "projectId":2571202, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Create_a_Project_Fund_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create a Project Fund by Assigning Code Values Using IDs", "description":"Payload to create a project fund using the project ID, start date, end date, fund code, name, and codeValuesFund fields such as code value ID and code type ID.", "value":{ "projectId":2571202, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Create_a_Project_Fund_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Datet":{ "summary":"Create a Project Fund that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a project fund using the project ID, start date, end date, fund code, name, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "projectId":2571202, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Project Fund" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Project_Fund_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Project Fund by Assigning Code Values Using Codes", "description":"Payload to create a project fund using the project ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code and code type code.", "value":{ "projectId":2571202, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFund", "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-project-post", "x-filename-id":"funds-project-post" } }, "/funds/project/batch":{ "put":{ "tags":[ "Funds" ], "summary":"Update Project Funds", "description":"Send a request to this endpoint to update one or more project funds.", "operationId":"/funds/project/batch_updateProjectFundsBatch", "requestBody":{ "description":"Project funds to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Funds":{ "summary":"Batch Update Project Funds", "description":"Payload to update the total cost of one or more project funds using the fund codes and project IDs.", "value":[ { "fundCode":"MF", "projectId":30101, "fundCost":{ "totalProject":20000 } }, { "fundCode":"CFUND", "projectId":30101, "fundCost":{ "totalProject":30000 } } ], "valueSetFlag":true }, "Batch_Update_Project_Funds_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Project Funds by Assigning Code Values Using Codes or IDs", "description":"Payload to update project funds using the fund ID and codeValuesFund fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "fundId":4101 }, { "codeValuesFund":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "fundId":4102 } ], "valueSetFlag":true }, "Batch_Update_Project_Funds_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Project Funds by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update project funds using the fund ID and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "fundId":4101 }, { "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "fundId":4102 } ], "valueSetFlag":true }, "Batch_Update_Project_Funds_to_Assign_Configured_Field":{ "summary":"Batch Update Project Funds to Assign Configured Field", "description":"Payload to update the total cost of one or more project funds using the fund codes, project IDs, and and configured field column name, column label, column definition ID, and text value.", "value":[ { "fundCode":"MF", "projectId":30101, "fundCost":{ "totalProject":20000 }, "configuredFields":[ { "columnName":"Notes", "textValue":"Project Fund" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "fundCode":"CFUND", "projectId":30101, "fundCost":{ "totalProject":30000 }, "configuredFields":[ { "columnName":"Notes", "textValue":"Project Fund" }, { "columnDefinationId":60045, "textValue":"N" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"funds-project-batch-put", "x-filename-id":"funds-project-batch-put" }, "post":{ "tags":[ "Funds" ], "summary":"Batch Create Project Funds", "description":"Send a request to this endpoint to create one or more project funds. An application object will be created for each JSON object provided in the request body.", "operationId":"/funds/project/batch_createProjectFundsBatch", "requestBody":{ "description":"Project funds to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Funds_that_include_Configured_Field_Text":{ "summary":"Batch Create Project Funds that include Configured Field Text", "description":"Payload to create one or more project funds using the project IDs, start dates, end dates, fund codes, names, costs, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "projectId":30101, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"MF", "fundName":"Municipal Funds", "fundCost":{ "totalProject":10000 }, "configuredFields":[ { "columnName":"Notes", "textValue":"Project Fund" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "projectId":30101, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"CFUND", "fundName":"CityScape Funding", "fundCost":{ "totalProject":30000 }, "configuredFields":[ { "columnName":"Notes", "textValue":"Project Fund" }, { "columnDefinationId":60045, "textValue":"Y" } ] } ], "valueSetFlag":true }, "Batch_Create_Project_Funds":{ "summary":"Batch Create Project Funds", "description":"Payload to create one or more project funds using the project IDs, start dates, end dates, fund codes, names, and costs.", "value":[ { "projectId":30101, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"MF", "fundName":"Municipal Funds", "fundCost":{ "totalProject":10000 } }, { "projectId":30101, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"CFUND", "fundName":"CityScape Funding", "fundCost":{ "totalProject":30000 } } ], "valueSetFlag":true }, "Batch_Create_Project_Funds_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Project Funds by Assigning Code Values Using Codes", "description":"Payload to create project funds using the project ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code and code type code.", "value":[ { "projectId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ] }, { "projectId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"PRVT", "fundName":"Private Grant", "codeValuesFund":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ] } ], "valueSetFlag":true }, "Batch_Create_Project_Funds_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Project Funds by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create project funds using the project ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "projectId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, { "projectId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"PRVT", "fundName":"Private Grant", "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-project-batch-post", "x-filename-id":"funds-project-batch-post" } }, "/funds/workspace":{ "put":{ "tags":[ "Funds" ], "summary":"Updates a Workspace Fund", "description":"Send a request to this endpoint to update a workspace fund.", "operationId":"/funds/workspace_updateWorkspaceFund", "requestBody":{ "description":"Workspace fund to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundInput", "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "examples":{ "Update_a_Workspace_Fund_by_Removing_a_Configured_Field":{ "summary":"Update a Workspace Fund by Removing a Configured Field", "description":"Payload to update the total cost of the workspace fund using the fund ID and specifying the action and column label for the configured field to be removed.", "value":{ "fundId":4001, "fundCost":{ "total":60000 }, "configuredFields":[ { "action":"DELETE", "columnLabel":"Reserved" } ] }, "valueSetFlag":true }, "Update_a_Workspace_Fund_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Update a Workspace Fund by Assigning Multiple Code Values Using IDs", "description":"Payload to update a workspace fund using the fund ID and codeValuesFund fields such as code value ID and code type ID.", "value":{ "fundId":740502, "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Update_a_Workspace_Fund_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Update a Workspace Fund by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update a workspace fund using the fund ID and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "fundId":740502, "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Update_a_Workspace_Fund_Using_Fund_ID":{ "summary":"Update a Workspace Fund Using Fund ID", "description":"Payload to update the total cost of the workspace fund using the fund ID.", "value":{ "fundId":4001, "fundCost":{ "total":60000 } }, "valueSetFlag":true }, "Update_a_Workspace_Fund_to_Assign_a_Boolean_Configured_Field":{ "summary":"Update a Workspace Fund to Assign a Boolean Configured Field", "description":"Payload to update the total cost of the workspace fund using the fund ID and configured field column label and text value.", "value":{ "fundId":4001, "fundCost":{ "total":60000 }, "configuredFields":[ { "columnLabel":"Reserved", "textValue":"Y" } ] }, "valueSetFlag":true }, "Update_a_Workspace_Fund_by_Assigning_Code_Values_Using_Codes":{ "summary":"Update a Workspace Fund by Assigning Code Values Using Codes", "description":"Payload to update a workspace fund using the workspace ID, fund code, and codeValuesFund fields such as code value code and code type code.", "value":{ "workspaceId":1098902, "fundCode":"GRNT", "codeValuesFund":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Update_a_Workspace_Fund_by_Assigning_Code_Values_Using_IDs":{ "summary":"Update a Workspace Fund by Assigning Code Values Using IDs", "description":"Payload to update a workspace fund using the fund ID and codeValuesFund fields such as code value ID and code type ID.", "value":{ "fundId":740502, "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"funds-workspace-put", "x-filename-id":"funds-workspace-put" }, "post":{ "tags":[ "Funds" ], "summary":"Create a Workspace Fund", "description":"Send a request to this endpoint to create a workspace fund.", "operationId":"/funds/workspace_createWorkspaceFund", "requestBody":{ "description":"Workspace fund to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundInput", "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "examples":{ "Create_a_Workspace_Fund":{ "summary":"Create a Workspace Fund", "description":"Payload to create a workspace fund using the workspace ID, start date, end date, fund code, name, and cost.", "value":{ "workspaceId":28001, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "fundCost":{ "total":50000 } }, "valueSetFlag":true }, "Create_a_Workspace_Fund_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Create a Workspace Fund by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create a workspace fund using the workspace ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":{ "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, "valueSetFlag":true }, "Create_a_Workspace_Fund_by_Assigning_Multiple_Code_Values_Using_IDs":{ "summary":"Create a Workspace Fund by Assigning Multiple Code Values Using IDs", "description":"Payload to create a workspace fund using the workspace ID, start date, end date, fund code, name, and codeValuesFund fields such as code value ID and code type ID.", "value":{ "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ] }, "valueSetFlag":true }, "Create_a_Workspace_Fund_that_includes_Multiple_Configured_Field_Values_including_Text_Number_and_Date":{ "summary":"Create a Workspace Fund that includes Multiple Configured Field Values including Text, Number, and Date", "description":"Payload to create a workspace fund using the workspace ID, start date, end date, fund code, name, and values for multiple configured fields which include column names along with the corresponding text, number, and date values.", "value":{ "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Workspace Fund" }, { "columnName":"SequenceNumber", "numberValue":250 }, { "columnName":"StartDate", "dateValue":"2024-10-23T00:00:00" } ] }, "valueSetFlag":true }, "Create_a_Workspace_Fund_by_Assigning_Code_Values_Using_IDs":{ "summary":"Create a Workspace Fund by Assigning Code Values Using IDs", "description":"Payload to create a workspace fund using the workspace ID, start date, end date, fund code, name, and codeValuesFund fields such as code value ID and code type ID.", "value":{ "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 } ] }, "valueSetFlag":true }, "Create_a_Workspace_Fund_by_Assigning_Code_Values_Using_Codes":{ "summary":"Create a Workspace Fund by Assigning Code Values Using Codes", "description":"Payload to create a workspace fund using the workspace ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code and code type code.", "value":{ "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" } ] }, "valueSetFlag":true }, "Create_a_Workspace_Fund_that_includes_Configured_Field_Text":{ "summary":"Create a Workspace Fund that includes Configured Field Text", "description":"Payload to create a workspace fund using the workspace ID, start date, end date, fund code, name, and values for the configured field which include column name and text value.", "value":{ "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Workspace Fund" } ] }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFund", "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-workspace-post", "x-filename-id":"funds-workspace-post" } }, "/funds/workspace/batch":{ "put":{ "tags":[ "Funds" ], "summary":"Update Workspace Funds", "description":"Send a request to this endpoint to update one or more workspace funds.", "operationId":"/funds/workspace/batch_updateWorkspaceFundsBatch", "requestBody":{ "description":"Workspace funds to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Workspace_Funds_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Update Workspace Funds by Assigning Hierarchical Code Values Using Codes", "description":"Payload to update workspace funds using the fund ID and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "fundId":4101 }, { "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ], "fundId":4102 } ], "valueSetFlag":true }, "Batch_Update_Workspace_Funds_to_Assign_Configured_Field":{ "summary":"Batch Update Workspace Funds to Assign Configured Field", "description":"Payload to update workspace funds using the fund ID and configured field column name, column label, column definition ID, and text value.", "value":[ { "configuredFields":[ { "columnName":"Notes", "textValue":"Workspace Fund" }, { "columnDefinationId":60045, "textValue":"N" } ], "fundId":4101 }, { "configuredFields":[ { "columnName":"Notes", "textValue":"Workspace Fund" }, { "columnDefinationId":60045, "textValue":"N" } ], "fundId":4102 } ], "valueSetFlag":true }, "Batch_Update_Workspace_Funds_by_Assigning_Code_Values_Using_Codes_or_IDs":{ "summary":"Batch Update Workspace Funds by Assigning Code Values Using Codes or IDs", "description":"Payload to update workspace funds using the fund ID and codeValuesFund fields such as code value code, code type code, code type ID, and code value ID.", "value":[ { "codeValuesFund":[ { "codeTypeId":15, "codeValueId":941941 }, { "codeTypeId":16, "codeValueId":941942 } ], "fundId":4101 }, { "codeValuesFund":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ], "fundId":4102 } ], "valueSetFlag":true }, "Batch_Update_Workspace_Funds_Using_Fund_IDs":{ "summary":"Batch Update Workspace Funds Using Fund IDs", "description":"Payload to update the total costs of one or more workspace funds using the fund IDs.", "value":[ { "fundId":4001, "fundCost":{ "total":60000 } }, { "fundId":4101, "fundCost":{ "total":70000 } } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"},\"warnings\":[{\"primaryKeyName\":\"objectIdFieldName\",\"uniqueFieldName\":\"object_code_01\",\"uniqueFieldValue\":\"objectCodeFieldName\",\"primaryKeyValue\":1,\"warningMessages\":[\"warning_message_1\",\"warning_message_2\"]}]}" } }, "x-internal-id":"funds-workspace-batch-put", "x-filename-id":"funds-workspace-batch-put" }, "post":{ "tags":[ "Funds" ], "summary":"Batch Create Workspace Funds", "description":"Send a request to this endpoint to create one or more workspace funds. An application object will be created for each JSON object provided in the request body.", "operationId":"/funds/workspace/batch_createWorkspaceFundsBatch", "requestBody":{ "description":"Workspace funds to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Workspace_Funds_that_include_Configured_Field_Text":{ "summary":"Batch Create Workspace Funds that include Configured Field Text", "description":"Payload to create workspace funds using the workspace ID, start date, end date, fund code, name, and values for the configured field which include column name, column definition ID, text value.", "value":[ { "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Workspace Fund" }, { "columnDefinationId":60045, "textValue":"N" } ] }, { "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"PRVT", "fundName":"Private Grant", "configuredFields":[ { "columnName":"Notes", "textValue":"Workspace Fund" }, { "columnDefinationId":60045, "textValue":"N" } ] } ], "valueSetFlag":true }, "Batch_Create_Workspace_Funds":{ "summary":"Batch Create Workspace Funds", "description":"Payload to create one or more workspace funds using the workspace IDs, start dates, end dates, fund codes, names, and costs.", "value":[ { "workspaceId":28001, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "fundCost":{ "total":50000 } }, { "workspaceId":28001, "startDate":"2022-02-11T00:00:00", "endDate":"2022-02-20T00:00:00", "fundCode":"Capital Project Funds", "fundName":"Capital Project Funds", "fundCost":{ "total":60000 } } ], "valueSetFlag":true }, "Batch_Create_Workspace_Funds_by_Assigning_Code_Values_Using_Codes":{ "summary":"Batch Create Workspace Funds by Assigning Code Values Using Codes", "description":"Payload to create workspace funds using the workspace ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code and code type code.", "value":[ { "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MODERN" }, { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 1" } ] }, { "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"PRVT", "fundName":"Private Grant", "codeValuesFund":[ { "codeTypeCode":"AREA", "codeValueCode":"LEVEL 2" }, { "codeTypeCode":"CONSTRUCTION_TYPE", "codeValueCode":"MEDIUM" } ] } ], "valueSetFlag":true }, "Batch_Create_Workspace_Funds_by_Assigning_Hierarchical_Code_Values_Using_Codes":{ "summary":"Batch Create Workspace Funds by Assigning Hierarchical Code Values Using Codes", "description":"Payload to create workspace funds using the workspace ID, start date, end date, fund code, name, and codeValuesFund fields such as code value code, code type code, and parent ID of the parent code value.", "value":[ { "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"GRNT", "fundName":"Government Grant", "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] }, { "workspaceId":1098902, "startDate":"2022-03-17T00:00:00", "endDate":"2022-03-20T00:00:00", "fundCode":"PRVT", "fundName":"Private Grant", "codeValuesFund":[ { "parentId":298203, "codeTypeCode":"Department", "codeValueCode":"FAC" } ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-workspace-batch-post", "x-filename-id":"funds-workspace-batch-post" } }, "/funds/workspace/portfolio/allocation":{ "post":{ "tags":[ "Funds" ], "summary":"Allocates a Workspace Fund to the Portfolio", "description":"Send a request to this endpoint to allocate a workspace fund to the portfolio.", "operationId":"/funds/workspace/portfolio/allocation_createWorkspaceToPortfolioAllocation", "requestBody":{ "description":"Allocation portfolio fund to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundInput", "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "examples":{ "Allocate_a_Workspace_Fund_to_the_Portfolio_Using_Codes":{ "summary":"Allocates a Workspace Fund to the Portfolio Using Codes", "description":"Payload to allocate the fund present in workspace to a portfolio using parent fund code, parent workspace Code, portfolio Code, workspace code and allocated amount.", "value":{ "parentFundCode":"MF", "parentWorkspaceCode":"Ananth Construction", "workspaceCode":"Ananth Construction", "portfolioCode":"Roadways Proposal", "fundCost":{ "totalCOR":1000 } }, "valueSetFlag":true }, "Allocate_a_Workspace_Fund_to_the_Portfolio_Using_IDs":{ "summary":"Allocates a Workspace Fund to the Portfolio Using IDs", "description":"Payload to allocate the fund present in workspace to a project using parent fund ID, capital portfolio ID and allocated amount.", "value":{ "parentFundId":2, "capitalPortfolioId":2001, "fundCost":{ "totalCOR":1000 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFund", "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-workspace-portfolio-allocation-post", "x-filename-id":"funds-workspace-portfolio-allocation-post" } }, "/funds/workspace/project/allocation":{ "post":{ "tags":[ "Funds" ], "summary":"Allocates a Workspace Fund to the Project", "description":"Send a request to this endpoint to allocate a workspace fund to the project.", "operationId":"/funds/workspace/project/allocation_createWorkspaceToProjectAllocation", "requestBody":{ "description":"Allocation project fund to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundInput", "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "examples":{ "Allocate_a_Workspace_Fund_to_the_Project_Using_IDs":{ "summary":"Allocate a Workspace Fund to the Project Using IDs", "description":"Payload to allocate the fund present in workspace to a project using parent fund ID, project ID and allocated amount.", "value":{ "parentFundId":2, "projectId":14101, "fundCost":{ "totalProject":1000 } }, "valueSetFlag":true }, "Allocate_a_Workspace_Fund_to_the_Project_Using_Codes":{ "summary":"Allocate a Workspace Fund to the Project Using Codes", "description":"Payload to allocate the fund present in workspace to a project using parent fund code, parent workspace Code, project Code, workspace code and allocated amount.", "value":{ "parentFundCode":"MF", "parentWorkspaceCode":"Ananth Construction", "workspaceCode":"Ananth Construction", "projectCode":"New Town - City Mall", "fundCost":{ "totalProject":1000 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFund", "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-workspace-project-allocation-post", "x-filename-id":"funds-workspace-project-allocation-post" } }, "/funds/workspace/workspace/allocation":{ "post":{ "tags":[ "Funds" ], "summary":"Allocates a Workspace Fund to the Child Workspace", "description":"Send a request to this endpoint to allocate a workspace fund to the child workspace.", "operationId":"/funds/workspace/workspace/allocation_createWorkspaceToWorkspaceAllocation", "requestBody":{ "description":"Allocation workspace fund to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFundInput", "$ref":"#/components/schemas/ApiEntityFundInput", "exampleSetFlag":false }, "examples":{ "Allocate_a_Workspace_Fund_to_the_Child_Workspace_Using_IDs":{ "summary":"Allocate a Workspace Fund to the Child Workspace Using IDs", "description":"Payload to allocate the fund present in workspace to a child workspace using parent fund ID, workspace ID and allocated amount.", "value":{ "parentFundId":1, "workspaceId":14001, "fundCost":{ "totalCOR":1000 } }, "valueSetFlag":true }, "Allocate_a_Workspace_Fund_to_the_Portfolio_Using_Codes":{ "summary":"Allocate a Workspace Fund to the Portfolio Using Codes", "description":"Payload to allocate the fund present in workspace to a portfolio using parent fund code, parent workspace Code, workspace code and allocated amount.", "value":{ "parentFundCode":"MF", "parentWorkspaceCode":"Ananth Construction", "workspaceCode":"Ananth Construction Bangalore", "fundCost":{ "totalCOR":1000 } }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFund", "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-workspace-workspace-allocation-post", "x-filename-id":"funds-workspace-workspace-allocation-post" } }, "/funds/{fundId}":{ "get":{ "tags":[ "Funds" ], "summary":"View a Fund", "description":"Send a request to this endpoint to view a fund for the specified fund ID.", "operationId":"/funds/{fundId}_find_97", "parameters":[ { "name":"fundId", "in":"path", "description":"ID of the fund to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityFund", "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-{fundId}-get", "x-filename-id":"funds-fundid-get" }, "delete":{ "tags":[ "Funds" ], "summary":"Deletes a Fund", "description":"Deletes a fund specified by Fund ID. The application object with an ID value that matches the value of the {fundId} path parameter will be deleted.", "operationId":"/funds/{fundId}_delete_76", "parameters":[ { "name":"fundId", "in":"path", "description":"Fund ID of the fund to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"funds-{fundId}-delete", "x-filename-id":"funds-fundid-delete" } }, "/funds/allocationRule/{filterId}":{ "get":{ "tags":[ "Funds" ], "summary":"View an Allocation Rule", "description":"This endpoint returns the allocation rule with an ID that matches the value of the {filterId} path parameter.", "operationId":"/funds/allocationRule/{filterId}_findAllocationRule", "parameters":[ { "name":"filterId", "in":"path", "description":"The ID of the allocation rule to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityNamedFilter", "$ref":"#/components/schemas/ApiEntityNamedFilter", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-allocationRule-{filterId}-get", "x-filename-id":"funds-allocationrule-filterid-get" }, "delete":{ "tags":[ "Funds" ], "summary":"Delete an Allocation Rule", "description":"Send a request to this endpoint to delete an allocation rule. The application object with an ID value that matches the value of the {filterId} path parameter will be deleted.", "operationId":"/funds/allocationRule/{filterId}_deleteAllocationRule", "parameters":[ { "name":"filterId", "in":"path", "description":"Allocation rule to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"funds-allocationRule-{filterId}-delete", "x-filename-id":"funds-allocationrule-filterid-delete" } }, "/funds/batch":{ "delete":{ "tags":[ "Funds" ], "summary":"Delete Funds", "description":"Delete funds specified by fund IDs.", "operationId":"/funds/batch_deleteBatch_59", "requestBody":{ "description":"IDs of the funds to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"funds-batch-delete", "x-filename-id":"funds-batch-delete" } }, "/funds/portfolio/list":{ "get":{ "tags":[ "Funds" ], "summary":"View Funds by Portfolio Code and Workspace Code", "description":"Send a request to this endpoint to view funds for the specified portfolio code and workspace code.", "operationId":"/funds/portfolio/list_findAllFundsByPortfolio", "parameters":[ { "name":"portfolioCode", "in":"query", "description":"Code of the portfolio to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-portfolio-list-get", "x-filename-id":"funds-portfolio-list-get" } }, "/funds/project/list":{ "get":{ "tags":[ "Funds" ], "summary":"View Funds by Project Code", "description":"Send a request to this endpoint to view funds for the specified project code.", "operationId":"/funds/project/list_findAllFundsByProjectCode", "parameters":[ { "name":"projectCode", "in":"query", "description":"Code of the project to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-project-list-get", "x-filename-id":"funds-project-list-get" } }, "/funds/workspace/list":{ "get":{ "tags":[ "Funds" ], "summary":"View Funds by Workspace Code", "description":"Send a request to this endpoint to view funds for the specified workspace code.", "operationId":"/funds/workspace/list_findAllFundsByWorkspaceCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-workspace-list-get", "x-filename-id":"funds-workspace-list-get" } }, "/funds/allocationRule/workspace":{ "get":{ "tags":[ "Funds" ], "summary":"View Allocation Rules by Workspace", "description":"Send a request to this endpoint to view allocation rules that matches the fields in the query parameters.", "operationId":"/funds/allocationRule/workspace_findAllocateRulesbyWorkspace", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNamedFilter", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-allocationRule-workspace-get", "x-filename-id":"funds-allocationrule-workspace-get" } }, "/funds/portfolio/fundtotal":{ "get":{ "tags":[ "Funds" ], "summary":"View Fund Totals by Portfolio Code and Workspace Code", "description":"Send a request to this endpoint to view fund totals for the specified portfolio code and workspace code.", "operationId":"/funds/portfolio/fundtotal_findPortfolioFundTotal", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"portfolioCode", "in":"query", "description":"Code of the portfolio to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundTotal", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-portfolio-fundtotal-get", "x-filename-id":"funds-portfolio-fundtotal-get" } }, "/funds/project/byFundCode":{ "get":{ "tags":[ "Funds" ], "summary":"View Funds by Project Code and Fund Code", "description":"Send a request to this endpoint to view a fund for the specified project code and fund code.", "operationId":"/funds/project/byFundCode_findProjectFundByCode", "parameters":[ { "name":"projectCode", "in":"query", "description":"Code of the project to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"fundCode", "in":"query", "description":"Code of the fund to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-project-byFundCode-get", "x-filename-id":"funds-project-byfundcode-get" } }, "/funds/project/byFundName":{ "get":{ "tags":[ "Funds" ], "summary":"View Funds by Project Code and Fund Name", "description":"Send a request to this endpoint to view a fund for the specified project code and fund name.", "operationId":"/funds/project/byFundName_findProjectFundByName", "parameters":[ { "name":"projectCode", "in":"query", "description":"Code of the project to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"fundName", "in":"query", "description":"Name of the fund to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-project-byFundName-get", "x-filename-id":"funds-project-byfundname-get" } }, "/funds/workspace/byFundCode":{ "get":{ "tags":[ "Funds" ], "summary":"View Funds by Workspace Code and Fund Code", "description":"Send a request to this endpoint to view a fund for the specified workspace code and fund code.", "operationId":"/funds/workspace/byFundCode_findWorkspaceFundByCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"fundCode", "in":"query", "description":"Code of the fund to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-workspace-byFundCode-get", "x-filename-id":"funds-workspace-byfundcode-get" } }, "/funds/workspace/byFundName":{ "get":{ "tags":[ "Funds" ], "summary":"View Funds by Workspace Code and Fund Name", "description":"Send a request to this endpoint to view a fund for the specified workspace code and fund name.", "operationId":"/funds/workspace/byFundName_findWorkspaceFundByName", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"fundName", "in":"query", "description":"Name of the fund to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFund", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-workspace-byFundName-get", "x-filename-id":"funds-workspace-byfundname-get" } }, "/funds/workspace/fundtotal":{ "get":{ "tags":[ "Funds" ], "summary":"View Fund Totals by Workspace Code", "description":"Send a request to this endpoint to view fund totals for the specified workspace code.", "operationId":"/funds/workspace/fundtotal_findWorkspaceFundTotal", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"Code of the workspace to be found.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundTotal", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"funds-workspace-fundtotal-get", "x-filename-id":"funds-workspace-fundtotal-get" } }, "/measure":{ "put":{ "tags":[ "Measure" ], "summary":"Update a Measure", "description":"Send a request to this endpoint to update a measure. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/measure_update_77", "requestBody":{ "description":"Measure object to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasureInput", "$ref":"#/components/schemas/ApiEntityMeasureInput", "exampleSetFlag":false }, "examples":{ "Update_a_Measure_Using_Measure_ID":{ "summary":"Update a Measure Using Measure ID", "description":"Payload to update name of a measure using measure ID.", "value":{ "measureName":"Planned Projects Count", "measureId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline measure." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"measure-put", "x-filename-id":"measure-put" }, "post":{ "tags":[ "Measure" ], "summary":"Create a Measure", "description":"Send a request to this endpoint to create a measure. An application object will be created using the JSON data provided in the request body.", "operationId":"/measure_create_82", "requestBody":{ "description":"Measure object to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasureInput", "$ref":"#/components/schemas/ApiEntityMeasureInput", "exampleSetFlag":false }, "examples":{ "Create_a_Measure":{ "summary":"Create a Measure", "description":"Payload to create a measure using workspace ID, enabledFlag, granularity, measure data type, measure entity type, measure name, actual type, target type, measure source type, and measure based flag.", "value":{ "enabledFlag":true, "granularity":"YEARLY", "measureDataType":"PERCENTAGE", "measureEntityType":"WORKSPACE", "measureBasedFlag":false, "measureName":"Planned Project Count 1", "actualType":"MANUAL", "targetType":"MANUAL", "measureSourceType":"PROJECT", "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline measure." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasure", "$ref":"#/components/schemas/ApiEntityMeasure", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"measure-post", "x-filename-id":"measure-post" } }, "/measure/batch":{ "put":{ "tags":[ "Measure" ], "summary":"Batch Update Measures", "description":"Send a request to this endpoint to update one or more measures. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/measure/batch_update_78", "requestBody":{ "description":"Measure objects to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Measures_Using_Measure_IDs":{ "summary":"Batch Update Measures Using Measure IDs", "description":"Payload to update name of one or more measures using measure IDs.", "value":[ { "measureName":"Planned Projects Count", "measureId":10001 }, { "measureName":"Planned Budget Active Projects Count", "measureId":10002 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline measure." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"measure-batch-put", "x-filename-id":"measure-batch-put" }, "post":{ "tags":[ "Measure" ], "summary":"Batch Create Measures", "description":"Send a request to this endpoint to create one or more measures. An application object will be created for each JSON object provided in the request body.", "operationId":"/measure/batch_create_83", "requestBody":{ "description":"Measures to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Measures":{ "summary":"Batch Create Measures", "description":"Payload to create one or more measures using workspace ID, enabledFlag, granularity, measure data type, measure entity type, measure name, actual type, target type, measure source type, and measure based flag.", "value":[ { "enabledFlag":true, "granularity":"YEARLY", "measureDataType":"PERCENTAGE", "measureEntityType":"WORKSPACE", "measureBasedFlag":false, "measureName":"Planned Project Count", "actualType":"MANUAL", "targetType":"MANUAL", "measureSourceType":"PROJECT", "workspaceId":10001 }, { "enabledFlag":true, "granularity":"YEARLY", "measureDataType":"PERCENTAGE", "measureEntityType":"WORKSPACE", "measureBasedFlag":false, "measureName":"Planned Budget Active Project Count", "actualType":"MANUAL", "targetType":"MANUAL", "measureSourceType":"PROJECT", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline measure." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"measure-batch-post", "x-filename-id":"measure-batch-post" }, "delete":{ "tags":[ "Measure" ], "summary":"Batch Delete Measures", "description":"Send a request to this endpoint to delete one or more measures. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/measure/batch_delete_78", "requestBody":{ "description":"IDs of Measures to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline measure." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"measure-batch-delete", "x-filename-id":"measure-batch-delete" } }, "/measure/{measureId}":{ "get":{ "tags":[ "Measure" ], "summary":"View a Measure", "description":"This endpoint returns a measure. that meet the following requirements:
        • The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.
        ", "operationId":"/measure/{measureId}_find_98", "parameters":[ { "name":"measureId", "in":"path", "description":"ID of the Measure to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested measure does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasure", "$ref":"#/components/schemas/ApiEntityMeasure", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"measure-{measureId}-get", "x-filename-id":"measure-measureid-get" }, "delete":{ "tags":[ "Measure" ], "summary":"Delete a Measure", "description":"Send a request to this endpoint to delete a measure. The application object with an ID value that matches the value of the {measureId} path parameter will be deleted.", "operationId":"/measure/{measureId}_delete_77", "parameters":[ { "name":"measureId", "in":"path", "description":"Id of Measure to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for a baseline measure." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"measure-{measureId}-delete", "x-filename-id":"measure-measureid-delete" } }, "/measure/workspace/{workspaceId}":{ "get":{ "tags":[ "Measure" ], "summary":"View all Measures by Workspace", "description":"This endpoint returns measures that meet the following requirements:
        • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        ", "operationId":"/measure/workspace/{workspaceId}_getMeasureByWorkspace", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested measure does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"measure-workspace-{workspaceId}-get", "x-filename-id":"measure-workspace-workspaceid-get" } }, "/measure/workspace/{workspaceId}/measureName/{measureName}":{ "get":{ "tags":[ "Measure" ], "summary":"View a Measure by Workspace and Name", "description":"This endpoint returns measures that meet the following requirements:
        • The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        • The object has a name that matches the value of the {measureName} path parameter.
        ", "operationId":"/measure/workspace/{workspaceId}/measureName/{measureName}_getMeasureByWorkspaceIdAndMeasureName", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"measureName", "in":"path", "description":"The name of a measure.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested measure does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasure", "$ref":"#/components/schemas/ApiEntityMeasure", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"measure-workspace-{workspaceId}-measureName-{measureName}-get", "x-filename-id":"measure-workspace-workspaceid-measurename-measurename-get" } }, "/measure/syncBatch":{ "post":{ "tags":[ "Measure" ], "summary":"Batch Sync Measures", "description":"Send a request to this endpoint to create or update one or more measures.", "operationId":"/measure/syncBatch_syncBatch_65", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any measure sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more measure objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Measure_Using_Workspace_ID":{ "summary":"Create or Update Measure Using Workspace ID", "description":"Payload to create or update a measure using the workspace ID, enabledFlag, granularity, measure data type, measure entity type, measure name, actual type, target type, measure source type, and measure based flag.", "value":[ { "enabledFlag":true, "granularity":"YEARLY", "measureDataType":"PERCENTAGE", "measureEntityType":"WORKSPACE", "measureBasedFlag":false, "measureName":"Planned Project Count", "actualType":"MANUAL", "targetType":"MANUAL", "measureSourceType":"PROJECT", "workspaceId":10001 } ], "valueSetFlag":true }, "Create_or_Update_Measure_Using_Workspace_Code":{ "summary":"Create or Update Measure Using Workspace Code", "description":"Payload to create or update a measure using the workspace code, enabledFlag, granularity, measure data type, measure entity type, measure name, actual type, target type, measure source type, and measure based flag.", "value":[ { "enabledFlag":true, "granularity":"YEARLY", "measureDataType":"PERCENTAGE", "measureEntityType":"WORKSPACE", "measureBasedFlag":false, "measureName":"Planned Project Count 1", "actualType":"MANUAL", "targetType":"MANUAL", "measureSourceType":"PROJECT", "workspaceCode":"North America" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline measure." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"measure-syncBatch-post", "x-filename-id":"measure-syncbatch-post" } }, "/measureThreshold":{ "put":{ "tags":[ "Measure Threshold" ], "summary":"Update a Measure Threshold ", "description":"Send a request to this endpoint to update a measure threshold. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/measureThreshold_update_79", "requestBody":{ "description":"Measure Threshold object to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasureThresholdInput", "$ref":"#/components/schemas/ApiEntityMeasureThresholdInput", "exampleSetFlag":false }, "examples":{ "Update_a_Measure_Threshold_Using_Measure_Threshold_ID":{ "summary":"Update a Measure Threshold Using Measure Threshold ID", "description":"Payload to update desirable state of a measure threshold using measure threshold ID.", "value":{ "measureThresholdId":10001, "desirableState":"HIGH_VALUES" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline threshold." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"measureThreshold-put", "x-filename-id":"measurethreshold-put" }, "post":{ "tags":[ "Measure Threshold" ], "summary":"Create a Measure Threshold", "description":"Send a request to this endpoint to create a measure threshold. An application object will be created using the JSON data provided in the request body.", "operationId":"/measureThreshold_create_84", "requestBody":{ "description":"Measure Threshold object to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasureThresholdInput", "$ref":"#/components/schemas/ApiEntityMeasureThresholdInput", "exampleSetFlag":false }, "examples":{ "Create_a_Measure_Threshold":{ "summary":"Create a Measure Threshold", "description":"Payload to create a measure threshold using measure ID, desirable state, and compute against type.", "value":{ "computeAgainstType":"ACTUAL_VALUE", "desirableState":"LOW_VALUES", "measureId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline threshold." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasureThreshold", "$ref":"#/components/schemas/ApiEntityMeasureThreshold", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"measureThreshold-post", "x-filename-id":"measurethreshold-post" } }, "/measureThreshold/batch":{ "put":{ "tags":[ "Measure Threshold" ], "summary":"Batch Update Measure Thresholds", "description":"Send a request to this endpoint to update one or more measure thresholds. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/measureThreshold/batch_update_80", "requestBody":{ "description":"Measure Threshold objects to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureThresholdInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Measure_Thresholds_Using_Measure_Threshold_IDs":{ "summary":"Batch Update Measure Thresholds Using Measure Threshold IDs", "description":"Payload to update desirable state of one or more measure thresholds using measure threshold IDs.", "value":[ { "measureThresholdId":10001, "desirableState":"HIGH_VALUES" }, { "measureThresholdId":10002, "desirableState":"HIGH_VALUES" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline threshold." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"measureThreshold-batch-put", "x-filename-id":"measurethreshold-batch-put" }, "post":{ "tags":[ "Measure Threshold" ], "summary":"Batch Create Measure Thresholds", "description":"Send a request to this endpoint to create one or more measure thresholds. An application object will be created for each JSON object provided in the request body.", "operationId":"/measureThreshold/batch_create_85", "requestBody":{ "description":"Measure Thresholds to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureThresholdInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Measure_Thresholds":{ "summary":"Batch Create Measure Thresholds", "description":"Payload to create one or more measure thresholds using measure ID, desirable state, and compute against type.", "value":[ { "computeAgainstType":"ACTUAL_VALUE", "desirableState":"LOW_VALUES", "measureId":10001 }, { "computeAgainstType":"ACTUAL_VALUE", "desirableState":"LOW_VALUES", "measureId":10002 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline threshold." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureThreshold", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"measureThreshold-batch-post", "x-filename-id":"measurethreshold-batch-post" }, "delete":{ "tags":[ "Measure Threshold" ], "summary":"Batch Delete Measure Thresholds ", "description":"Send a request to this endpoint to delete one or more measure thresholds. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/measureThreshold/batch_delete_80", "requestBody":{ "description":"Ids of Measure Thresholds to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline threshold." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"measureThreshold-batch-delete", "x-filename-id":"measurethreshold-batch-delete" } }, "/measureThreshold/{measureThresholdId}":{ "get":{ "tags":[ "Measure Threshold" ], "summary":"View a Measure Threshold ", "description":"This endpoint returns measure thresholds that meet the following requirements:
        • The object has an ID that matches the value of the {measureThresholdId} path parameter.
        ", "operationId":"/measureThreshold/{measureThresholdId}_find_99", "parameters":[ { "name":"measureThresholdId", "in":"path", "description":"ID of the Measure Threshold to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested measure threshold does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityMeasureThreshold", "$ref":"#/components/schemas/ApiEntityMeasureThreshold", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"measureThreshold-{measureThresholdId}-get", "x-filename-id":"measurethreshold-measurethresholdid-get" }, "delete":{ "tags":[ "Measure Threshold" ], "summary":"Delete a Measure Threshold ", "description":"Send a request to this endpoint to delete a measure threshold. The application object with an ID value that matches the value of the {measureThresholdId} path parameter will be deleted.", "operationId":"/measureThreshold/{measureThresholdId}_delete_79", "parameters":[ { "name":"measureThresholdId", "in":"path", "description":"Id of Measure Threshold to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for a baseline threshold." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"measureThreshold-{measureThresholdId}-delete", "x-filename-id":"measurethreshold-measurethresholdid-delete" } }, "/measureThreshold/measure/{measureId}":{ "get":{ "tags":[ "Measure Threshold" ], "summary":"View a Measure Threshold by Measure ", "description":"This endpoint returns measure thresholds that meet the following requirements:
        • The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.
        ", "operationId":"/measureThreshold/measure/{measureId}_getMeasureThresholdsByMeasureId", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested measure threshold does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureThreshold", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"measureThreshold-measure-{measureId}-get", "x-filename-id":"measurethreshold-measure-measureid-get" } }, "/measureThreshold/syncBatch":{ "post":{ "tags":[ "Measure Threshold" ], "summary":"Batch Sync Measure Thresholds", "description":"Send a request to this endpoint to create or update one or more measure thresholds.", "operationId":"/measureThreshold/syncBatch_syncBatch_66", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any measure threshold sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more measure threshold objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureThresholdInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Measure_Threshold":{ "summary":"Create or Update a Measure Threshold", "description":"Payload to create or update a measure threshold using compute against type, desirable state, and measure ID.", "value":[ { "computeAgainstType":"ACTUAL_VALUE", "desirableState":"LOW_VALUES", "measureId":10001 } ], "valueSetFlag":true }, "Create_or_Update_a_Measure_Threshold_Using_Codes":{ "summary":"Create or Update a Measure Threshold Using Codes", "description":"Payload to create or update a measure threshold using compute against type, desirable state, workspace code, and measure name.", "value":[ { "computeAgainstType":"ACTUAL_VALUE", "desirableState":"LOW_VALUES", "measureName":"TestMeasure", "workspaceCode":"Bangalore" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline threshold." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"measureThreshold-syncBatch-post", "x-filename-id":"measurethreshold-syncbatch-post" } }, "/office":{ "put":{ "tags":[ "Office" ], "summary":"Update an Office", "description":"Send a request to this endpoint to update an office.", "operationId":"/office_update_81", "requestBody":{ "description":"Office to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityOfficeInput", "$ref":"#/components/schemas/ApiEntityOfficeInput", "exampleSetFlag":false }, "examples":{ "Update_a_Office_Using_Office_ID":{ "summary":"Update a Office Using Office ID", "description":"Payload to update name of an office using office ID.", "value":{ "officeId":160102, "officeName":"US - New York" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"office-put", "x-filename-id":"office-put" }, "post":{ "tags":[ "Office" ], "summary":"Create an Office", "description":"Send a request to this endpoint to create an office.", "operationId":"/office_create_86", "requestBody":{ "description":"Office to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityOfficeInput", "$ref":"#/components/schemas/ApiEntityOfficeInput", "exampleSetFlag":false }, "examples":{ "Create_a_Office":{ "summary":"Create a Office", "description":"Payload to create an office using company ID, country code, name, and postal code.", "value":{ "companyId":10001, "officeCountryCode":"US", "officeName":"New York", "officePostalCode":"100001" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityOffice", "$ref":"#/components/schemas/ApiEntityOffice", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"office-post", "x-filename-id":"office-post" } }, "/office/batch":{ "put":{ "tags":[ "Office" ], "summary":"Batch Update Offices", "description":"Send a request to this endpoint to update one or more offices.", "operationId":"/office/batch_updateBatch_60", "requestBody":{ "description":"Office objects to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityOfficeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Offices_Using_Office_IDs":{ "summary":"Batch Update Offices Using Office IDs", "description":"Payload to update name of one or more offices using office IDs.", "value":[ { "officeId":10001, "officeName":"US - New York" }, { "officeId":10002, "officeName":"US - Texas" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"office-batch-put", "x-filename-id":"office-batch-put" }, "post":{ "tags":[ "Office" ], "summary":"Batch Create Offices", "description":"Send a request to this endpoint to create one or more offices.", "operationId":"/office/batch_createBatch_63", "requestBody":{ "description":"Office objects to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityOfficeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Offices":{ "summary":"Batch Create Offices", "description":"Payload to create one or more offices using company ID, country code, name, and postal code.", "value":[ { "companyId":10001, "officeCountryCode":"US", "officeName":"New York", "officePostalCode":"100001" }, { "companyId":10002, "officeCountryCode":"US", "officeName":"Texas", "officePostalCode":"77494" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityOffice", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"office-batch-post", "x-filename-id":"office-batch-post" }, "delete":{ "tags":[ "Office" ], "summary":"Batch Delete Offices", "description":"Send a request to this endpoint to delete one or more offices.", "operationId":"/office/batch_deleteBatch_60", "requestBody":{ "description":"Office IDs to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"office-batch-delete", "x-filename-id":"office-batch-delete" } }, "/office/{officeId}":{ "get":{ "tags":[ "Office" ], "summary":"View an Office", "description":"Send a request to the endpoint to return details of the office with office ID given as a {officeId} path parameter.", "operationId":"/office/{officeId}_find_100", "parameters":[ { "name":"officeId", "in":"path", "description":"The system-generated identifier of an office. ", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityOffice", "$ref":"#/components/schemas/ApiEntityOffice", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"office-{officeId}-get", "x-filename-id":"office-officeid-get" }, "delete":{ "tags":[ "Office" ], "summary":"Delete an Office", "description":"Send a request to this endpoint to delete an office. The application object with an ID value that matches the value of the {officeId} path parameter will be deleted.", "operationId":"/office/{officeId}_delete_81", "parameters":[ { "name":"officeId", "in":"path", "description":"ID of the Office that has to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"office-{officeId}-delete", "x-filename-id":"office-officeid-delete" } }, "/office/name/{officeName}":{ "get":{ "tags":[ "Office" ], "summary":"View Offices for a specified name", "description":"Send a request to this endpoint to view all offices having specified office name.", "operationId":"/office/name/{officeName}_findOfficesByCompany", "parameters":[ { "name":"officeName", "in":"path", "description":"Name of the Offices to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityOffice", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"office-name-{officeName}-get", "x-filename-id":"office-name-officename-get" } }, "/office/company/{companyName}/{postalCode}/{countryCode}":{ "get":{ "tags":[ "Office" ], "summary":"View Offices for a specified company", "description":"Send a request to this endpoint to view all offices of a specified company.", "operationId":"/office/company/{companyName}/{postalCode}/{countryCode}_findOfficesByCompany_1", "parameters":[ { "name":"companyName", "in":"path", "description":"Company name of the company to be found.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"postalCode", "in":"path", "description":"Postal code value of the company.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"countryCode", "in":"path", "description":"Country code value of the company.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityOffice", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"office-company-{companyName}-{postalCode}-{countryCode}-get", "x-filename-id":"office-company-companyname-postalcode-countrycode-get" } }, "/office/syncBatch":{ "post":{ "tags":[ "Office" ], "summary":"Batch Sync Offices", "description":"Send a request to this endpoint to create or update one or more offices.", "operationId":"/office/syncBatch_syncBatch_67", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any office record sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more office objects.# API ENDPOINT ERRORS #", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityOfficeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_an_Office_Using_Codes":{ "summary":"Create or Update an Office Using Codes", "description":"Payload to create or update an office using company name, postal code, country code, country code, name, and postal code.", "value":[ { "companyName":"tenant1", "postalCode":"500084", "countryCode":"USA", "officeCountryCode":"US", "officeName":"New York", "officePostalCode":"100001" } ], "valueSetFlag":true }, "Create_or_Update_an_Office":{ "summary":"Create or Update an Office", "description":"Payload to create or update an office using company ID, country code, name, and postal code.", "value":[ { "companyId":10001, "officeCountryCode":"US", "officeName":"New York", "officePostalCode":"100001" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"office-syncBatch-post", "x-filename-id":"office-syncbatch-post" } }, "/portfolioMeasure":{ "put":{ "tags":[ "Portfolio Measure" ], "summary":"Update a Portfolio Measure ", "description":"Send a request to this endpoint to update a portfolio measure. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/portfolioMeasure_update_82", "requestBody":{ "description":"Portfolio Measure object to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioMeasureInput", "$ref":"#/components/schemas/ApiEntityPortfolioMeasureInput", "exampleSetFlag":false }, "examples":{ "Update_an_Portfolio_Measure_Using_Codes":{ "summary":"Update an Portfolio Measure Using Codes", "description":"Payload to update a portfolio enabled flag measure using measure name, portfolio name, and workspace code.", "value":{ "portfolioName":"IT Portfolio", "measureName":"Total Cost", "workspaceCode":"Ananth Constructions", "enabledFlag":false }, "valueSetFlag":true }, "Update_an_Portfolio_Measure":{ "summary":"Update an Portfolio Measure", "description":"Payload to update a portfolio enabled flag measure using the portfolio measure ID.", "value":{ "portfolioMeasureId":2202, "enabledFlag":false }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"portfolioMeasure-put", "x-filename-id":"portfoliomeasure-put" }, "post":{ "tags":[ "Portfolio Measure" ], "summary":"Create a Portfolio Measure", "description":"Send a request to this endpoint to create a portfolio measure. An application object will be created using the JSON data provided in the request body.", "operationId":"/portfolioMeasure_create_87", "requestBody":{ "description":"Portfolio Measure object to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioMeasureInput", "$ref":"#/components/schemas/ApiEntityPortfolioMeasureInput", "exampleSetFlag":false }, "examples":{ "Create_a_Portfolio_Measure":{ "summary":"Create a Portfolio Measure", "description":"Payload to create a portfolio measure using the portfolio ID and measure ID.", "value":{ "measureId":204, "portfolioId":10001, "enabledFlag":true }, "valueSetFlag":true }, "Create_a_Portfolio_Measure_Using_Codes":{ "summary":"Create a Portfolio Measure Using Codes", "description":"Payload to create a portfolio measure using the portfolio name, workspace code, and measure name.", "value":{ "measureName":"Total Cost", "portfolioName":"IT Portfolio", "workspaceCode":"Ananth Constructions", "enabledFlag":true }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioMeasure", "$ref":"#/components/schemas/ApiEntityPortfolioMeasure", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasure-post", "x-filename-id":"portfoliomeasure-post" } }, "/portfolioMeasure/batch":{ "put":{ "tags":[ "Portfolio Measure" ], "summary":"Batch Update Portfolio Measures", "description":"Send a request to this endpoint to update one or more portfolio measures. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/portfolioMeasure/batch_update_83", "requestBody":{ "description":"Portfolio Measure objects to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Portfolio_Measures":{ "summary":"Batch Update Portfolio Measures", "description":"Payload to update enabled flag of one or more portfolio measures using the portfolio measure IDs.", "value":[ { "portfolioMeasureId":2202, "enabledFlag":true }, { "portfolioMeasureId":2201, "enabledFlag":false } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"portfolioMeasure-batch-put", "x-filename-id":"portfoliomeasure-batch-put" }, "post":{ "tags":[ "Portfolio Measure" ], "summary":"Batch Create Portfolio Measures", "description":"Send a request to this endpoint to create one or more portfolio measures. An application object will be created for each JSON object provided in the request body.", "operationId":"/portfolioMeasure/batch_create_88", "requestBody":{ "description":"Portfolio Measures to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Portfolio_Measures":{ "summary":"Batch Create Portfolio Measures", "description":"Payload to create one or more portfolio measures using the portfolio IDs and measure IDs.", "value":[ { "measureId":204, "portfolioId":10001, "enabledFlag":true }, { "measureId":203, "portfolioId":12001, "enabledFlag":true } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasure-batch-post", "x-filename-id":"portfoliomeasure-batch-post" }, "delete":{ "tags":[ "Portfolio Measure" ], "summary":"Batch Delete Portfolio Measures ", "description":"Send a request to this endpoint to delete one or more portfolio measures. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/portfolioMeasure/batch_delete_83", "requestBody":{ "description":"Ids of Portfolio Measures to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"portfolioMeasure-batch-delete", "x-filename-id":"portfoliomeasure-batch-delete" } }, "/portfolioMeasure/{portfolioMeasureId}":{ "get":{ "tags":[ "Portfolio Measure" ], "summary":"View a Portfolio Measure ", "description":"This endpoint returns a portfolio measures that meet the following requirements:
        • The object has an ID that matches the value of the {portfolioMeasureId} path parameter.
        ", "operationId":"/portfolioMeasure/{portfolioMeasureId}_find_101", "parameters":[ { "name":"portfolioMeasureId", "in":"path", "description":"ID of the Portfolio Measure to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Portfolio Measure does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioMeasure", "$ref":"#/components/schemas/ApiEntityPortfolioMeasure", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasure-{portfolioMeasureId}-get", "x-filename-id":"portfoliomeasure-portfoliomeasureid-get" }, "delete":{ "tags":[ "Portfolio Measure" ], "summary":"Delete a Portfolio Measure ", "description":"Send a request to this endpoint to delete a portfolio measure. The application object with an ID value that matches the value of the {portfolioMeasureId} path parameter will be deleted.", "operationId":"/portfolioMeasure/{portfolioMeasureId}_delete_82", "parameters":[ { "name":"portfolioMeasureId", "in":"path", "description":"Id of Portfolio Measure to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for a baseline portfolio measure." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"portfolioMeasure-{portfolioMeasureId}-delete", "x-filename-id":"portfoliomeasure-portfoliomeasureid-delete" } }, "/portfolioMeasure/measure/{measureId}":{ "get":{ "tags":[ "Portfolio Measure" ], "summary":"View a Portfolio Measure by Measure ", "description":"This endpoint returns a portfolio measures that meet the following requirements:
        • The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.
        ", "operationId":"/portfolioMeasure/measure/{measureId}_getPortfolioMeasuresByMeasureId", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Portfolio Measure does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasure-measure-{measureId}-get", "x-filename-id":"portfoliomeasure-measure-measureid-get" } }, "/portfolioMeasure/currentUserPortfolios":{ "get":{ "tags":[ "Portfolio Measure" ], "summary":"View All Portfolio Measures Owned by a User", "description":"Send a request to this endpoint to view all portfolio measures owned by the current user.", "operationId":"/portfolioMeasure/currentUserPortfolios_getPortfolioMeasuresByPortfolioId", "responses":{ "404":{ "description":"The requested Portfolio Measure does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasure-currentUserPortfolios-get", "x-filename-id":"portfoliomeasure-currentuserportfolios-get" } }, "/portfolioMeasure/portfolio/{portfolioId}":{ "get":{ "tags":[ "Portfolio Measure" ], "summary":"View a Portfolio Measure by Portfolio ", "description":"This endpoint returns a portfolio measure that meet the following requirements:
        • The object is associated with a portfolio with an ID value that matches the value of the {portfolioId} path parameter.
        ", "operationId":"/portfolioMeasure/portfolio/{portfolioId}_getPortfolioMeasuresByPortfolioId_1", "parameters":[ { "name":"portfolioId", "in":"path", "description":"The system-generated identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested Portfolio Measure does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasure", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasure-portfolio-{portfolioId}-get", "x-filename-id":"portfoliomeasure-portfolio-portfolioid-get" } }, "/portfolioMeasure/syncBatch":{ "post":{ "tags":[ "Portfolio Measure" ], "summary":"Batch Sync Portfolio Measures", "description":"Send a request to this endpoint to create or update one or more portfolio measures.", "operationId":"/portfolioMeasure/syncBatch_syncBatch_68", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any portfolio measures sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more portfolio measure objects.# PORTFOLIO MEASURE VALUE RESOURCE #", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Portfolio_Measure":{ "summary":"Create or Update a Portfolio Measure", "description":"Payload to create or update a portfolio measure using the portfolio ID and measure ID.", "value":[ { "measureId":204, "portfolioId":10001, "enabledFlag":true } ], "valueSetFlag":true }, "Create_or_Update_a_Portfolio_Measure_Using_Codes":{ "summary":"Create or Update a Portfolio Measure Using Codes", "description":"Payload to create or update a portfolio measure using the portfolio name, workspace code, and measure name.", "value":[ { "measureName":"Total Cost", "portfolioName":"IT Portfolio", "workspaceCode":"Ananth Constructions", "enabledFlag":true } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasure-syncBatch-post", "x-filename-id":"portfoliomeasure-syncbatch-post" } }, "/portfolioMeasureValue/{portfolioMeasureValueId}":{ "get":{ "tags":[ "Portfolio Measure Value" ], "summary":"View a Porfolio Measure Value ", "description":"This endpoint returns portfolio measure values that meet the following requirements:
        • The object has an ID that matches the value of the {portfolioMeasureValueId} path parameter.
        ", "operationId":"/portfolioMeasureValue/{portfolioMeasureValueId}_find_102", "parameters":[ { "name":"portfolioMeasureValueId", "in":"path", "description":"ID of the Project Measure Value to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The portfolio measure value does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioMeasureValue", "$ref":"#/components/schemas/ApiEntityPortfolioMeasureValue", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureValue-{portfolioMeasureValueId}-get", "x-filename-id":"portfoliomeasurevalue-portfoliomeasurevalueid-get" } }, "/portfolioMeasureValue/measure/{measureId}":{ "get":{ "tags":[ "Portfolio Measure Value" ], "summary":"View a Porfolio Measure Value by Measure ", "description":"This endpoint returns portfolio measure values that meet the following requirements:
        • The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.
        ", "operationId":"/portfolioMeasureValue/measure/{measureId}_getPortfolioMeasureValueByMeasureId", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The portfolio measure value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureValue-measure-{measureId}-get", "x-filename-id":"portfoliomeasurevalue-measure-measureid-get" } }, "/portfolioMeasureValue/measure/{measureId}/portfolio/{capitalPortfolioId}":{ "get":{ "tags":[ "Portfolio Measure Value" ], "summary":"View a Porfolio Measure Value by Measure and Portfolio ", "description":"This endpoint returns portfolio measure values that meet the following requirements:
        • The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.
        • The object is associated with a portfolio with an ID value that matches the value of the {capitalPortfolioId} path parameter.
        ", "operationId":"/portfolioMeasureValue/measure/{measureId}/portfolio/{capitalPortfolioId}_getPortfolioMeasureValueByMeasureIdAndPortfolioId", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"capitalPortfolioId", "in":"path", "description":"The system-generated identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The portfolio measure value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureValue-measure-{measureId}-portfolio-{capitalPortfolioId}-get", "x-filename-id":"portfoliomeasurevalue-measure-measureid-portfolio-capitalportfolioid-get" } }, "/portfolioMeasureValue/portfolio/{capitalPortfolioId}":{ "get":{ "tags":[ "Portfolio Measure Value" ], "summary":"View Porfolio Measure Value by Portfolio ", "description":"This endpoint returns portfolio measure values that meet the following requirements:
        • The object is associated with a portfolio with an ID value that matches the value of the {capitalPortfolioId} path parameter.
        ", "operationId":"/portfolioMeasureValue/portfolio/{capitalPortfolioId}_getPortfolioMeasureValueByPortfolioId", "parameters":[ { "name":"capitalPortfolioId", "in":"path", "description":"The system-generated identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The portfolio measure value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureValue-portfolio-{capitalPortfolioId}-get", "x-filename-id":"portfoliomeasurevalue-portfolio-capitalportfolioid-get" } }, "/portfolioMeasureManualValue":{ "put":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"Update a Portfolio Measure Manual Value ", "description":"Send a request to this endpoint to update a portfolio measure manual value. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.", "operationId":"/portfolioMeasureManualValue_update_84", "requestBody":{ "description":"Portfolio Measure Manual Value object to be updated.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioMeasureManualValueInput", "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValueInput", "exampleSetFlag":false }, "examples":{ "Update_a_Portfolio_Measure_Manual_Value":{ "summary":"Update a Portfolio Measure Manual Value", "description":"Payload to update portfolio measure manual value variance using portfolio measure manual value ID.", "value":{ "portfolioMeasureManualValueId":2, "varValue":7 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"portfolioMeasureManualValue-put", "x-filename-id":"portfoliomeasuremanualvalue-put" }, "post":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"Create a Portfolio Measure Manual Value", "description":"Send a request to this endpoint to create a portfolio measure manual value. An application object will be created using the JSON data provided in the request body.", "operationId":"/portfolioMeasureManualValue_create_89", "requestBody":{ "description":"Portfolio Measure Manual Value object to be created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioMeasureManualValueInput", "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValueInput", "exampleSetFlag":false }, "examples":{ "Create_a_Portfolio_Measure_Manual_Value":{ "summary":"Create a Portfolio Measure Manual Value", "description":"Payload to create a portfolio measure manual value using the portfolio ID and measure ID.", "value":{ "capitalPortfolioId":12001, "beginDate":"2023-03-19T23:02:15", "endDate":"2023-03-30T23:02:15", "measureId":2001, "targetValue":100, "actualValue":40, "varValue":50 }, "valueSetFlag":true }, "Create_a_Portfolio_Measure_Manual_Value_Using_Codes":{ "summary":"Create a Portfolio Measure Manual Value Using Codes", "description":"Payload to create a portfolio measure manual value using the portfolio name, measure name, and workspace code.", "value":{ "portfolioName":"IT Portfolio", "measureName":"Referenceable Clients", "beginDate":"2023-03-19T23:02:15", "endDate":"2023-03-30T23:02:15", "workspaceCode":"Ananth Constructions", "targetValue":10, "actualValue":4, "varValue":3 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioMeasureManualValue", "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValue", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureManualValue-post", "x-filename-id":"portfoliomeasuremanualvalue-post" } }, "/portfolioMeasureManualValue/batch":{ "put":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"Batch Update Portfolio Measure Manual Values ", "description":"Send a request to this endpoint to update one or more a portfolio measure manual value. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.", "operationId":"/portfolioMeasureManualValue/batch_update_85", "requestBody":{ "description":"Portfolio Measure Manual Value objects to be updated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Portfolio_Measure_Manual_Values":{ "summary":"Batch Update Portfolio Measure Manual Values", "description":"Payload to update enabled flag of one or more portfolio measures using the portfolio measure manual value IDs.", "value":[ { "portfolioMeasureManualValueId":3, "varValue":6 }, { "portfolioMeasureManualValueId":4, "varValue":6 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"portfolioMeasureManualValue-batch-put", "x-filename-id":"portfoliomeasuremanualvalue-batch-put" }, "post":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"Batch Create Portfolio Measure Manual Values", "description":"Send a request to this endpoint to create one or more portfolio measure manual values. An application object will be created for each JSON object provided in the request body.", "operationId":"/portfolioMeasureManualValue/batch_create_90", "requestBody":{ "description":"Portfolio Measure Manual Values to be created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Portfolio_Measure_Manual_Values":{ "summary":"Batch Create Portfolio Measure Manual Values", "description":"Payload to create one or more portfolio measure manual values using the portfolio ID and measure ID.", "value":[ { "capitalPortfolioId":12001, "beginDate":"2023-03-19T23:02:15", "endDate":"2023-03-30T23:02:15", "measureId":208, "targetValue":10, "actualValue":4, "varValue":5 }, { "capitalPortfolioId":10001, "beginDate":"2023-03-19T23:02:15", "endDate":"2023-03-30T23:02:15", "measureId":205, "targetValue":10, "actualValue":4, "varValue":5 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureManualValue-batch-post", "x-filename-id":"portfoliomeasuremanualvalue-batch-post" }, "delete":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"Batch Delete Portfolio Measure Manual Values ", "description":"Send a request to this endpoint to delete one or more portfolio measure manual values. Objects with ID values that match the values provided in the request body will be deleted.", "operationId":"/portfolioMeasureManualValue/batch_delete_85", "requestBody":{ "description":"Ids of Portfolio Measure Manual Values to be deleted.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline portfolio measure." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"portfolioMeasureManualValue-batch-delete", "x-filename-id":"portfoliomeasuremanualvalue-batch-delete" } }, "/portfolioMeasureManualValue/{portfolioMeasureManualValueId}":{ "get":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"View a Portfolio Measure Manual Value ", "description":"This endpoint returns portfolio measure manual values that meet the following requirements:
        • The object has an ID that matches the value of the {portfolioMeasureManualValueId} path parameter.
        ", "operationId":"/portfolioMeasureManualValue/{portfolioMeasureManualValueId}_find_103", "parameters":[ { "name":"portfolioMeasureManualValueId", "in":"path", "description":"ID of the Portfolio Measure Manual Value to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio measure manual value does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityPortfolioMeasureManualValue", "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValue", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureManualValue-{portfolioMeasureManualValueId}-get", "x-filename-id":"portfoliomeasuremanualvalue-portfoliomeasuremanualvalueid-get" }, "delete":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"Delete a Portfolio Measure Manual Value ", "description":"Send a request to this endpoint to delete a portfolio measure manual value. The application object with an ID value that matches the value of the {portfolioMeasureManualValueId} path parameter will be deleted.", "operationId":"/portfolioMeasureManualValue/{portfolioMeasureManualValueId}_delete_84", "parameters":[ { "name":"portfolioMeasureManualValueId", "in":"path", "description":"Id of Portfolio Measure Manual Value to be deleted.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for a baseline portfolio measure." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"portfolioMeasureManualValue-{portfolioMeasureManualValueId}-delete", "x-filename-id":"portfoliomeasuremanualvalue-portfoliomeasuremanualvalueid-delete" } }, "/portfolioMeasureManualValue/measure/{measureId}":{ "get":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"View a Portfolio Measure Manual Value by Measure", "description":"This endpoint returns portfolio measure manual values that meet the following requirements:
        • The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.
        ", "operationId":"/portfolioMeasureManualValue/measure/{measureId}_getPortfolioMeasureValueXReferenceByMeasureId", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio measure manual value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureManualValue-measure-{measureId}-get", "x-filename-id":"portfoliomeasuremanualvalue-measure-measureid-get" } }, "/portfolioMeasureManualValue/measure/{measureId}/portfolio/{capitalPortfolioId}":{ "get":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"View a Portfolio Measure Manual Value by Measure and Portfolio ", "description":"This endpoint returns portfolio measure manual values that meet the following requirements:
        • The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.
        • The object is associated with a portfolio with an ID value that matches the value of the {capitalPortfolioId} path parameter.
        ", "operationId":"/portfolioMeasureManualValue/measure/{measureId}/portfolio/{capitalPortfolioId}_getPortfolioMeasureValueXReferenceByMeasureIdAndPortfolioId", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"capitalPortfolioId", "in":"path", "description":"The system-generated identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio measure manual value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureManualValue-measure-{measureId}-portfolio-{capitalPortfolioId}-get", "x-filename-id":"portfoliomeasuremanualvalue-measure-measureid-portfolio-capitalportfolioid-get" } }, "/portfolioMeasureManualValue/portfolio/{capitalPortfolioId}":{ "get":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"View a Portfolio Measure Manual Value by Portfolio ", "description":"This endpoint returns portfolio measure manual values that meet the following requirements:
        • The object is associated with a portfolio with an ID value that matches the value of the {capitalPortfolioId} path parameter.
        .", "operationId":"/portfolioMeasureManualValue/portfolio/{capitalPortfolioId}_getPortfolioMeasureValueXReferenceByPortfolioId", "parameters":[ { "name":"capitalPortfolioId", "in":"path", "description":"The system-generated identifier of a portfolio.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested portfolio measure manual value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureManualValue-portfolio-{capitalPortfolioId}-get", "x-filename-id":"portfoliomeasuremanualvalue-portfolio-capitalportfolioid-get" } }, "/portfolioMeasureManualValue/syncBatch":{ "post":{ "tags":[ "Portfolio Measure Manual Value" ], "summary":"Batch Sync Portfolio Measure Manual Values", "description":"Send a request to this endpoint to create or update one or more portfolio measure manual values.", "operationId":"/portfolioMeasureManualValue/syncBatch_syncBatch_69", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any portfolio measure manual values sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more portfolio measure manual value objects.# Program Budget Item Resource #", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioMeasureManualValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Portfolio_Measure_Manual_Value":{ "summary":"Create or Update a Portfolio Measure Manual Value", "description":"Payload to create or update a portfolio measure manual value using the portfolio ID and measure ID.", "value":[ { "capitalPortfolioId":12001, "beginDate":"2023-03-19T23:02:15", "endDate":"2023-03-30T23:02:15", "measureId":2001, "targetValue":100, "actualValue":40, "varValue":50 } ], "valueSetFlag":true }, "Create_or_Update_a_Portfolio_Measure_Manual_Value_Using_Codes":{ "summary":"Create or Update a Portfolio Measure Manual Value Using Codes", "description":"Payload to create a portfolio measure manual value using the portfolio name, measure name, and workspace code.", "value":[ { "portfolioName":"IT Portfolio", "measureName":"Referenceable Clients", "beginDate":"2023-03-19T23:02:15", "endDate":"2023-03-30T23:02:15", "workspaceCode":"Ananth Constructions", "targetValue":10, "actualValue":4, "varValue":3 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"portfolioMeasureManualValue-syncBatch-post", "x-filename-id":"portfoliomeasuremanualvalue-syncbatch-post" } }, "/projectCompany":{ "put":{ "tags":[ "Project Company" ], "summary":"Update a Project Company", "description":"Send a request to this endpoint to update a project company.", "operationId":"/projectCompany_update_86", "requestBody":{ "description":"A project company object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectCompanyInput", "$ref":"#/components/schemas/ApiEntityProjectCompanyInput", "exampleSetFlag":false }, "examples":{ "Update_a_Project_Company_Using_Project_Company_ID":{ "summary":"Update a Project Company Using Project Company ID", "description":"Payload to update color of a project company using project company ID.", "value":{ "projectCompanyId":10001, "color":"RED" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline company." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectCompany-put", "x-filename-id":"projectcompany-put" }, "post":{ "tags":[ "Project Company" ], "summary":"Create a Project Company", "description":"Send a request to this endpoint to create a project company.", "operationId":"/projectCompany_create_91", "requestBody":{ "description":"A project company object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectCompanyInput", "$ref":"#/components/schemas/ApiEntityProjectCompanyInput", "exampleSetFlag":false }, "examples":{ "Create_a_Project_Company":{ "summary":"Create a Project Company", "description":"Payload to create a project company using company ID, project ID, and color.", "value":{ "projectId":786503, "color":"BLUE", "companyId":140101 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline company." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectCompany", "$ref":"#/components/schemas/ApiEntityProjectCompany", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCompany-post", "x-filename-id":"projectcompany-post" } }, "/projectCompany/batch":{ "put":{ "tags":[ "Project Company" ], "summary":"Batch Update Project Companies", "description":"Send a request to this endpoint to update one or more project companies.", "operationId":"/projectCompany/batch_updateBatch_61", "requestBody":{ "description":"A project company object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCompanyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Project_Companies_Using_Project_Company_IDs":{ "summary":"Batch Update Project Companies Using Project Company IDs", "description":"Payload to update color of one or more project companies using project company IDs.", "value":[ { "projectCompanyId":10001, "color":"RED" }, { "projectCompanyId":10002, "color":"BLUE" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline company." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"projectCompany-batch-put", "x-filename-id":"projectcompany-batch-put" }, "post":{ "tags":[ "Project Company" ], "summary":"Batch Create Project Companies", "description":"Send a request to this endpoint to create one or more project companies.", "operationId":"/projectCompany/batch_createBatch_64", "requestBody":{ "description":"A project company object.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCompanyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Project_Companies":{ "summary":"Batch Create Project Companies", "description":"Payload to create one or more project companies using company ID, project ID, and color.", "value":[ { "projectId":10001, "color":"BLUE", "companyId":10001 }, { "projectId":10002, "color":"RED", "companyId":10002 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline company." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCompany", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCompany-batch-post", "x-filename-id":"projectcompany-batch-post" }, "delete":{ "tags":[ "Project Company" ], "summary":"Batch Delete Project Companies ", "description":"Send a request to this endpoint to delete one or more project companies.", "operationId":"/projectCompany/batch_deleteBatch_61", "requestBody":{ "description":"One or more system-generated identifiers of project companies.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline company." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectCompany-batch-delete", "x-filename-id":"projectcompany-batch-delete" } }, "/projectCompany/{projectCompanyId}":{ "get":{ "tags":[ "Project Company" ], "summary":"View a Project Company ", "description":"This endpoint returns a project company that meet the following requirements:
        • The object has an ID that matches the value of the {projectCompanyId} path parameter.
        ", "operationId":"/projectCompany/{projectCompanyId}_find_104", "parameters":[ { "name":"projectCompanyId", "in":"path", "description":"The system-generated identifier of a project company.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project company does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectCompany", "$ref":"#/components/schemas/ApiEntityProjectCompany", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCompany-{projectCompanyId}-get", "x-filename-id":"projectcompany-projectcompanyid-get" }, "delete":{ "tags":[ "Project Company" ], "summary":"Delete a Project Company by Task ", "description":"Send a request to this endpoint to delete a project company. The application object with an ID value that matches the value of the {projectCompanyId} path parameter will be deleted.", "operationId":"/projectCompany/{projectCompanyId}_delete_86", "parameters":[ { "name":"projectCompanyId", "in":"path", "description":"The system-generated identifier of a project company.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for a baseline company." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"projectCompany-{projectCompanyId}-delete", "x-filename-id":"projectcompany-projectcompanyid-delete" } }, "/projectCompany/company/{companyName}/{postalCode}":{ "get":{ "tags":[ "Project Company" ], "summary":"View all Project Companies by Company Name and Postal Code", "description":"This endpoint returns project companies that meet the following requirements:
        • The object has a name that matches the value of the {companyName} path parameter.
        • The object has a code that matches the value of the {postalCode} path parameter.
        ", "operationId":"/projectCompany/company/{companyName}/{postalCode}_findByCompany", "parameters":[ { "name":"companyName", "in":"path", "description":"The name of a company.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"postalCode", "in":"path", "description":"The postal code associated with a company.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "400":{ "description":"Invalid input for a baseline company." }, "404":{ "description":"The requested project company does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCompany", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCompany-company-{companyName}-{postalCode}-get", "x-filename-id":"projectcompany-company-companyname-postalcode-get" } }, "/projectCompany/workspace/{workspaceCode}/project/{projectCode}":{ "get":{ "tags":[ "Project Company" ], "summary":"View all Project Companies by Code", "description":"This endpoint returns project companies that meet the following requirements:
        • The object is associated with a project with a code value that matches the value of the {projectCode} path parameter.
        • The object is associated with a workspace with a code value that matches the value of the {workspaceCode} path parameter.
        ", "operationId":"/projectCompany/workspace/{workspaceCode}/project/{projectCode}_findByProjectCode_1", "parameters":[ { "name":"workspaceCode", "in":"path", "description":"The user-specified identifier of a workspace.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"path", "description":"The user-specified identifier of a project.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested project company does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCompany", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCompany-workspace-{workspaceCode}-project-{projectCode}-get", "x-filename-id":"projectcompany-workspace-workspacecode-project-projectcode-get" } }, "/projectCompany/project/{projectId}":{ "get":{ "tags":[ "Project Company" ], "summary":"View all Project Companies by Project", "description":"This endpoint returns project companies that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        ", "operationId":"/projectCompany/project/{projectId}_findByProjectId_9", "parameters":[ { "name":"projectId", "in":"path", "description":"ID of the project to be found.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project company does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCompany", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCompany-project-{projectId}-get", "x-filename-id":"projectcompany-project-projectid-get" } }, "/projectCompany/syncBatch":{ "post":{ "tags":[ "Project Company" ], "summary":"Batch Sync Project Companies", "description":"Send a request to this endpoint to create or update one or more project companies.", "operationId":"/projectCompany/syncBatch_syncBatch_70", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag will fail the request if an error occurs while processing any project company record sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more project company objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCompanyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_Project_Companies_Using_Company_ID":{ "summary":"Create or Update Project Companies Using Company ID", "description":"Payload to create or update one or more project companies using the color, company ID, project code, and workspace code.", "value":[ { "color":"fff59c", "companyId":2001, "projectCode":"Rolls-Royce Holdings", "workspaceCode":"North America" } ], "valueSetFlag":true }, "Create_or_Update_Project_Companies_Using_Project_ID":{ "summary":"Create or Update Project Companies Using Project ID", "description":"Payload to create or update one or more project companies using the color, project ID, postal code, and company name.", "value":[ { "color":"fff59c", "projectId":2305002, "companyName":"PPC1", "postalCode":"560101" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectCompany-syncBatch-post", "x-filename-id":"projectcompany-syncbatch-post" } }, "/projectMeasureValue/{projectMeasureValueId}":{ "get":{ "tags":[ "Project Measure Value" ], "summary":"View a Project Measure Value ", "description":"This endpoint returns a project measure value that meet the following requirements:
        • The object has an ID that matches the value of the {projectMeasureValueId} path parameter.
        ", "operationId":"/projectMeasureValue/{projectMeasureValueId}_find_105", "parameters":[ { "name":"projectMeasureValueId", "in":"path", "description":"The system-generated identifier of a project measure value.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project measure value does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityProjectMeasureValue", "$ref":"#/components/schemas/ApiEntityProjectMeasureValue", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"projectMeasureValue-{projectMeasureValueId}-get", "x-filename-id":"projectmeasurevalue-projectmeasurevalueid-get" } }, "/projectMeasureValue/measure/{measureId}":{ "get":{ "tags":[ "Project Measure Value" ], "summary":"View all Project Measure Values by Measure ", "description":"This endpoint returns a project measure value that meet the following requirements:
        • The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.
        ", "operationId":"/projectMeasureValue/measure/{measureId}_getProjectMeasuresByMeasureId", "parameters":[ { "name":"measureId", "in":"path", "description":"The system-generated identifier of a measure.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project measure value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectMeasureValue-measure-{measureId}-get", "x-filename-id":"projectmeasurevalue-measure-measureid-get" } }, "/projectMeasureValue/project/{projectId}":{ "get":{ "tags":[ "Project Measure Value" ], "summary":"View all Project Measure Values by Project ", "description":"This endpoint returns a project measure value that meet the following requirements:
        • The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
        ", "operationId":"/projectMeasureValue/project/{projectId}_getProjectMeasuresByProjectId", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested project measure value does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"projectMeasureValue-project-{projectId}-get", "x-filename-id":"projectmeasurevalue-project-projectid-get" } }, "/reason":{ "put":{ "tags":[ "Reason" ], "summary":"Update a Reason", "description":"Send a request to this endpoint to update a reason.", "operationId":"/reason_update_87", "requestBody":{ "description":"A reason object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReasonInput", "$ref":"#/components/schemas/ApiEntityReasonInput", "exampleSetFlag":false }, "examples":{ "Update_a_Reason_Using_Reason_ID":{ "summary":"Update a Reason Using Reason ID", "description":"Payload to update name of a reason using reason ID.", "value":{ "reasonId":10001, "reasonName":"Time estimation error (Underestimated)" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline reason." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"reason-put", "x-filename-id":"reason-put" }, "post":{ "tags":[ "Reason" ], "summary":"Create a Reason", "description":"Send a request to this endpoint to create a reason.", "operationId":"/reason_create_92", "requestBody":{ "description":"A reason object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReasonInput", "$ref":"#/components/schemas/ApiEntityReasonInput", "exampleSetFlag":false }, "examples":{ "Create_a_Reason":{ "summary":"Create a Reason", "description":"Payload to create a reason using workspace ID, abbreviation, and reason name.", "value":{ "abbreviation":"TWW (E&C)", "reasonName":"Time estimation error (Underestimate)", "workspaceId":10001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline reason." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReason", "$ref":"#/components/schemas/ApiEntityReason", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"reason-post", "x-filename-id":"reason-post" } }, "/reason/batch":{ "put":{ "tags":[ "Reason" ], "summary":"Batch Update Reasons", "description":"Send a request to this endpoint to update one or more reasons.", "operationId":"/reason/batch_updateBatch_62", "requestBody":{ "description":"One or more reason objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReasonInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Update_Reasons_Using_Reason_IDs":{ "summary":"Batch Update Reasons Using Reason IDs", "description":"Payload to update name of one or more reasons using reason IDs.", "value":[ { "reasonId":10001, "reasonName":"Time estimation error (Underestimated)" }, { "reasonId":10002, "reasonName":"Materials not available (Underestimated)" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline reason." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"reason-batch-put", "x-filename-id":"reason-batch-put" }, "post":{ "tags":[ "Reason" ], "summary":"Batch Create Reasons", "description":"Send a request to this endpoint to create one or more reasons.", "operationId":"/reason/batch_createBatch_65", "requestBody":{ "description":"One or more reason objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReasonInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_Reasons":{ "summary":"Batch Create Reasons", "description":"Payload to create one or more reasons using workspace ID, abbreviation, and reason name.", "value":[ { "abbreviation":"TWW (E&C)", "reasonName":"Time estimation error (Underestimate)", "workspaceId":10001 }, { "abbreviation":"MNA (E&C)", "reasonName":"Materials not available (Underestimate)", "workspaceId":10001 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline reason." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReason", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"reason-batch-post", "x-filename-id":"reason-batch-post" }, "delete":{ "tags":[ "Reason" ], "summary":"Batch Delete Reasons", "description":"Send a request to this endpoint to delete one or more reasons.", "operationId":"/reason/batch_deleteBatch_62", "requestBody":{ "description":"One or more system-generated identifiers of a reason.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline reason." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"reason-batch-delete", "x-filename-id":"reason-batch-delete" } }, "/reason/{reasonId}":{ "get":{ "tags":[ "Reason" ], "summary":"View a Reason", "description":"This endpoint returns reasons that meet the following requirements:
        • The object is associated with a reason with an ID value that matches the value of the {reasonId} path parameter.
        ", "operationId":"/reason/{reasonId}_find_106", "parameters":[ { "name":"reasonId", "in":"path", "description":"The system-generated identifier of a reason.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested reason does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReason", "$ref":"#/components/schemas/ApiEntityReason", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"reason-{reasonId}-get", "x-filename-id":"reason-reasonid-get" }, "delete":{ "tags":[ "Reason" ], "summary":"Delete a Reason", "description":"Send a request to this endpoint to delete a reason. The application object with an ID value that matches the value of the {reasonId} path parameter will be deleted.", "operationId":"/reason/{reasonId}_delete_87", "parameters":[ { "name":"reasonId", "in":"path", "description":"The system-generated identifier of a reason.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for a baseline reason." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"reason-{reasonId}-delete", "x-filename-id":"reason-reasonid-delete" } }, "/reason/workspace/{workspaceId}/name/{reasonName}":{ "get":{ "tags":[ "Reason" ], "summary":"View a Reason by Workspace and Name", "description":"This endpoint returns reasons that meet the following requirements:
        • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        • The object has a name that matches the value of the {reasonName} path parameter.
        ", "operationId":"/reason/workspace/{workspaceId}/name/{reasonName}_findByWorkspaceAndName_1", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, { "name":"reasonName", "in":"path", "description":"The name of a reason.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested reason does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityReason", "$ref":"#/components/schemas/ApiEntityReason", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"reason-workspace-{workspaceId}-name-{reasonName}-get", "x-filename-id":"reason-workspace-workspaceid-name-reasonname-get" } }, "/reason/workspace/{workspaceId}":{ "get":{ "tags":[ "Reason" ], "summary":"View all Reasons by Workspace", "description":"This endpoint returns reasons that meet the following requirements:
        • The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
        ", "operationId":"/reason/workspace/{workspaceId}_findByWorkspaceId_4", "parameters":[ { "name":"workspaceId", "in":"path", "description":"The system-generated identifier of a workspace.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested reason does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReason", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"reason-workspace-{workspaceId}-get", "x-filename-id":"reason-workspace-workspaceid-get" } }, "/reason/syncBatch":{ "post":{ "tags":[ "Reason" ], "summary":"Batch Sync Reasons", "description":"Send a request to this endpoint to create or update one or more reasons.", "operationId":"/reason/syncBatch_syncBatch_71", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any reason record sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more reason objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReasonInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch_Create_or_Update_Reasons_Using_Workspace_ID":{ "summary":"Batch Create or Update Reasons Using Workspace ID", "description":"Payload to create or update one or more reasons using the workspace ID, abbreviation, and reason name.", "value":[ { "abbreviation":"TWW (E&C)", "reasonName":"Time estimation error (Underestimate)", "workspaceId":10001 } ], "valueSetFlag":true }, "Batch_Create_or_Update_Reasons_Using_Workspace_Code":{ "summary":"Batch Create or Update Reasons Using Workspace Code", "description":"Payload to create or update one or more reasons using the workspace code, abbreviation, reason name, pushDownType, and applies to change event.", "value":[ { "abbreviation":"TEE (E&C)", "reasonName":"Time estimation error (Underestimate)", "workspaceCode":"North America", "pushDownType":"MANUAL", "appliesTo":[ "CHANGE_EVENT" ] } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"reason-syncBatch-post", "x-filename-id":"reason-syncbatch-post" } }, "/scopeItemAssignmentActivity":{ "put":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"Update a Scope Item Assignment Activity", "description":"Send a request to this endpoint to update a scope item assignment.", "operationId":"/scopeItemAssignmentActivity_update_88", "requestBody":{ "description":"A scope item assignment activity object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemAssignmentActivityInput", "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivityInput", "exampleSetFlag":false }, "examples":{ "Update_a_Scope_Item_Assignment_Activity":{ "summary":"Update a Scope Item Assignment Activity", "description":"Payload to update the activity ID of a scope item assignment activity using the scope item assignment activity ID and the scope item assignment ID.", "value":{ "scopeItemAssignmentActivityId":102, "activityId":846002, "scopeItemAssignmentId":38001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"scopeItemAssignmentActivity-put", "x-filename-id":"scopeitemassignmentactivity-put" }, "post":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"Create a Scope Item Assignment Activity", "description":"Send a request to this endpoint to create a scope item assignment.", "operationId":"/scopeItemAssignmentActivity_create_93", "requestBody":{ "description":"A scope item assignment activity object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemAssignmentActivityInput", "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivityInput", "exampleSetFlag":false }, "examples":{ "Create_a_Scope_Item_Assignment_Activity":{ "summary":"Create a Scope Item Assignment Activity", "description":"Payload to create a scope item assignment activity using the activity ID and scope item assignment ID.", "value":{ "activityId":846001, "scopeItemAssignmentId":38001 }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemAssignmentActivity", "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivity", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignmentActivity-post", "x-filename-id":"scopeitemassignmentactivity-post" } }, "/scopeItemAssignmentActivity/batch":{ "put":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"Batch Update Scope Item Assignment Activities", "description":"Send a request to this endpoint to update one or more scope item assignments.", "operationId":"/scopeItemAssignmentActivity/batch_updateBatch_63", "requestBody":{ "description":"One or more scope item assignment objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivityInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch Update Scope Item Assignment Activities":{ "summary":"Batch Update Scope Item Assignment Activities", "description":"Payload to update the activity ID of one or more scope item assignment activities using the scope item assignment activity ID and the scope item assignment ID.", "value":[ { "scopeItemAssignmentActivityId":103, "activityId":846002, "scopeItemAssignmentId":38002 }, { "scopeItemAssignmentActivityId":104, "activityId":846003, "scopeItemAssignmentId":38003 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "200":{ "description":"A collection of object IDs mapped to a canonical link of the object. For example - {\"links\":{\"1\":\"https://[host]:[port]/api/restapi/[object]/1\",\"2\":\"https://[host]:[port]/api/restapi/[object]/2\"}}" } }, "x-internal-id":"scopeItemAssignmentActivity-batch-put", "x-filename-id":"scopeitemassignmentactivity-batch-put" }, "post":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"Batch Create Scope Item Assignment Activities", "description":"Send a request to this endpoint to create one or more scope item assignments.", "operationId":"/scopeItemAssignmentActivity/batch_createBatch_66", "requestBody":{ "description":"One or more scope item assignment activity objects.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivityInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Batch Create Scope Item Assignment Activities":{ "summary":"Batch Create Scope Item Assignment Activities", "description":"Payload to create one or more scope item assignment activities using the activity ID and the scope item assignment ID.", "value":[ { "activityId":846002, "scopeItemAssignmentId":38002 }, { "activityId":846003, "scopeItemAssignmentId":38003 } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignmentActivity-batch-post", "x-filename-id":"scopeitemassignmentactivity-batch-post" }, "delete":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"Batch Delete Scope Item Assignment Activities", "description":"Send a request to this endpoint to delete one or more scope item assignments.", "operationId":"/scopeItemAssignmentActivity/batch_deleteBatch_63", "requestBody":{ "description":"One or more system-generated identifiers of an scope item assignment activities.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid Input." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"scopeItemAssignmentActivity-batch-delete", "x-filename-id":"scopeitemassignmentactivity-batch-delete" } }, "/scopeItemAssignmentActivity/{scopeItemAssignmentActivityId}":{ "get":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"View a Scope Item Assignment Activity ", "description":"This endpoint returns scope item assignments that meet the following requirements:
        • The object has an ID that matches the value of the {scopeItemAssignmentActivityId} path parameter.
        ", "operationId":"/scopeItemAssignmentActivity/{scopeItemAssignmentActivityId}_find_107", "parameters":[ { "name":"scopeItemAssignmentActivityId", "in":"path", "description":"The system-generated identifier of a scope item assignment activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityScopeItemAssignmentActivity", "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivity", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignmentActivity-{scopeItemAssignmentActivityId}-get", "x-filename-id":"scopeitemassignmentactivity-scopeitemassignmentactivityid-get" }, "delete":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"Delete a Scope Item Assignment Activity", "description":"Send a request to this endpoint to delete a scope item assignment activity. The application object with an ID value that matches the value of the {scopeItemAssignmentActivityId} path parameter will be deleted.", "operationId":"/scopeItemAssignmentActivity/{scopeItemAssignmentActivityId}_delete_88", "parameters":[ { "name":"scopeItemAssignmentActivityId", "in":"path", "description":"The system-generated identifier of a scope item assignment activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "204":{ "description":"Successful operation with no content." }, "404":{ "description":"The requested object does not exist, or you do not have access to it." } }, "x-internal-id":"scopeItemAssignmentActivity-{scopeItemAssignmentActivityId}-delete", "x-filename-id":"scopeitemassignmentactivity-scopeitemassignmentactivityid-delete" } }, "/scopeItemAssignmentActivity/activity/{activityId}":{ "get":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"View all Scope Item Assignment Activities by Activity", "description":"This endpoint returns scope item assignments that meet the following requirements:
        • The object is associated with an activity with an ID value that matches the value of the {activityId} path parameter.
        ", "operationId":"/scopeItemAssignmentActivity/activity/{activityId}_getAssignmentActByActivity", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "204":{ "description":"Successful operation with no content." }, "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignmentActivity-activity-{activityId}-get", "x-filename-id":"scopeitemassignmentactivity-activity-activityid-get" }, "delete":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"Delete Scope Item Assignment Activities by Activity", "description":"Send a request to this endpoint to delete one or more scope item assignments. The application object with an parent activity ID value that matches the value of the {activityId} path parameter will be deleted.", "operationId":"/scopeItemAssignmentActivity/activity/{activityId}_deleteByActivityId", "parameters":[ { "name":"activityId", "in":"path", "description":"The system-generated identifier of an activity.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "204":{ "description":"Successful operation with no content." }, "400":{ "description":"Invalid Input." } }, "x-internal-id":"scopeItemAssignmentActivity-activity-{activityId}-delete", "x-filename-id":"scopeitemassignmentactivity-activity-activityid-delete" } }, "/scopeItemAssignmentActivity/scopeItemAssignment/{scopeItemAssignmentId}":{ "get":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"View all Scope Item Assignment Activities by Scope Item Assignment", "description":"This endpoint returns scope item assignments that meet the following requirements:
        • The object is associated with a scope item assignment with an ID value that matches the value of the {scopeItemAssigmentId} path parameter.
        ", "operationId":"/scopeItemAssignmentActivity/scopeItemAssignment/{scopeItemAssignmentId}_getAssignmentActByAssignment", "parameters":[ { "name":"scopeItemAssignmentId", "in":"path", "description":"The system-generated identifier of an assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "204":{ "description":"Successful operation with no content." }, "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignmentActivity-scopeItemAssignment-{scopeItemAssignmentId}-get", "x-filename-id":"scopeitemassignmentactivity-scopeitemassignment-scopeitemassignmentid-get" }, "delete":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"Delete Scope Item Assignment Activities by Scope Item Assignment", "description":"Send a request to this endpoint to delete one or more scope item assignments. The application object with an parent scope item assignment ID value that matches the value of the {scopeItemAssignmentId} path parameter will be deleted.", "operationId":"/scopeItemAssignmentActivity/scopeItemAssignment/{scopeItemAssignmentId}_deleteByAssignmentId", "parameters":[ { "name":"scopeItemAssignmentId", "in":"path", "description":"The system-generated identifier of an assignment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "204":{ "description":"Successful operation with no content." }, "400":{ "description":"Invalid Input." } }, "x-internal-id":"scopeItemAssignmentActivity-scopeItemAssignment-{scopeItemAssignmentId}-delete", "x-filename-id":"scopeitemassignmentactivity-scopeitemassignment-scopeitemassignmentid-delete" } }, "/scopeItemAssignmentActivity/project/{projectId}":{ "get":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"View All Scope Item Assignment Activities by Project", "description":"This endpoint returns scope item assignments that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        ", "operationId":"/scopeItemAssignmentActivity/project/{projectId}_getAssignmentActivityByProject", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "204":{ "description":"Successful operation with no content." }, "404":{ "description":"The requested object does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignmentActivity-project-{projectId}-get", "x-filename-id":"scopeitemassignmentactivity-project-projectid-get" } }, "/scopeItemAssignmentActivity/syncBatch":{ "post":{ "tags":[ "Scope Item Assignment Activity" ], "summary":"Batch Sync Scope Item Assignment Activities", "description":"Send a request to this endpoint to create or update one or more scope item assignment activities.", "operationId":"/scopeItemAssignmentActivity/syncBatch_syncBatch_72", "parameters":[ { "name":"singleTransaction", "in":"header", "description":"Enabling this boolean flag fails to complete the request if an error occurred when processing any scope item assignment activity record sent as part of the request.
        Allowed Values: [ \"true\", \"false\" ]", "schema":{ "type":"boolean", "exampleSetFlag":false, "types":[ "boolean" ], "default":false } } ], "requestBody":{ "description":"One or more scope item assignment activities.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentActivityInput", "exampleSetFlag":false }, "types":[ "array" ] }, "examples":{ "Create_or_Update_a_Scope_Assignment_Activity":{ "summary":"Create or Update a Scope Assignment Activity", "description":"Payload to create or update a scope assignment activity link using the activity ID and scope assignment ID.", "value":[ { "activityId":846001, "scopeItemAssignmentId":38001 } ], "valueSetFlag":true }, "Create_or_Update_a_Scope_Assignment_Activity_Using_Codes":{ "summary":"Create or Update a Scope Assignment Activity Using Codes", "description":"Payload to create or update a scope assignment activity link using the activity code, project code, workspace code, scope item code, work package code and scope item assignment code.", "value":[ { "activityCode":"A1013", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "scopeItemCode":"ScopeItems1", "workPackageCode":"Package1", "scopeItemAssignmentCode":"ScopeAssignments1" } ], "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input." }, "207":{ "description":"The object was successfully integrated.", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySyncApiResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"scopeItemAssignmentActivity-syncBatch-post", "x-filename-id":"scopeitemassignmentactivity-syncbatch-post" } }, "/workManagerTaskCommitment":{ "post":{ "tags":[ "Task Commitment" ], "summary":"Create a Task Commitment", "description":"Send a request to this endpoint to create a task commitment.", "operationId":"/workManagerTaskCommitment_create_94", "requestBody":{ "description":"A task commitment object.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTaskCommitmentInput", "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitmentInput", "exampleSetFlag":false }, "examples":{ "Create_a_Work_Manager_Task_Commitment":{ "summary":"Create a Work Manager Task Commitment", "description":"Payload to create a work manager task commitment using work manager task ID, project ID, due date, comments, and project company ID.", "value":{ "dueDate":"2023-03-27T23:59:59", "workManagerTaskId":1036403, "projectId":1888907, "projectCompanyId":1996707, "comments":"Resource shortage" }, "valueSetFlag":true }, "Create_a_Work_Manager_Task_Commitment_Using_Codes":{ "summary":"Create a Work Manager Task Commitment Using Codes", "description":"Payload to create a work manager task commitment using work manager task code, project code, workspace code, due date, comments, project company name, company postal code, and company color.", "value":{ "dueDate":"2023-03-27T23:59:59", "workManagerTaskCode":"Ins-Plumb-T104", "projectCode":"ATP", "workspaceCode":"Ananth Constructions", "companyName":"stable3a", "companyPostalCode":"19111", "projectCompanyColor":"0072bc", "comments":"Tools unavailability" }, "valueSetFlag":true } }, "exampleSetFlag":false } }, "required":true }, "responses":{ "400":{ "description":"Invalid input for a baseline manager task." }, "201":{ "description":"The object was successfully created.", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTaskCommitment", "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskCommitment-post", "x-filename-id":"workmanagertaskcommitment-post" } }, "/workManagerTaskCommitment/{workManagerTaskCommitmentId}":{ "get":{ "tags":[ "Task Commitment" ], "summary":"View a Task Commitment ", "description":"This endpoint returns task commitments that meet the following requirements:
        • The object has an ID that matches the value of the {workManagerTaskCommitmentId} path parameter.
        ", "operationId":"/workManagerTaskCommitment/{workManagerTaskCommitmentId}_find_108", "parameters":[ { "name":"workManagerTaskCommitmentId", "in":"path", "description":"The system-generated identifier of a task commitment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested task commitment does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTaskCommitment", "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskCommitment-{workManagerTaskCommitmentId}-get", "x-filename-id":"workmanagertaskcommitment-workmanagertaskcommitmentid-get" }, "delete":{ "tags":[ "Task Commitment" ], "summary":"Delete a Task Commitment ", "description":"Send a request to this endpoint to delete a task commitment. The application object with an ID value that matches the value of the {workManagerTaskCommitmentId} path parameter will be deleted.", "operationId":"/workManagerTaskCommitment/{workManagerTaskCommitmentId}_delete_89", "parameters":[ { "name":"workManagerTaskCommitmentId", "in":"path", "description":"The system-generated identifier of a task commitment.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"Invalid input for the Task Commitment service." }, "204":{ "description":"Successful operation with no content." } }, "x-internal-id":"workManagerTaskCommitment-{workManagerTaskCommitmentId}-delete", "x-filename-id":"workmanagertaskcommitment-workmanagertaskcommitmentid-delete" } }, "/workManagerTaskCommitment/allCommitment/task/{workManagerTaskId}":{ "get":{ "tags":[ "Task Commitment" ], "summary":"View all Task Commitments by Task", "description":"This endpoint returns task commitments that meet the following requirements:
        • The object is associated with a task with an ID value that matches the value of the {workManagerTaskId} path parameter.
        ", "operationId":"/workManagerTaskCommitment/allCommitment/task/{workManagerTaskId}_findAllCommitmentByTask", "parameters":[ { "name":"workManagerTaskId", "in":"path", "description":"The system-generated identifier of a task.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested task commitment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskCommitment-allCommitment-task-{workManagerTaskId}-get", "x-filename-id":"workmanagertaskcommitment-allcommitment-task-workmanagertaskid-get" } }, "/workManagerTaskCommitment/project/{projectId}":{ "get":{ "tags":[ "Task Commitment" ], "summary":"View all Task Commitments by Project", "description":"This endpoint returns task commitments that meet the following requirements:
        • The object is associated with a project with an ID value that matches the value of the {projectId} path parameter.
        ", "operationId":"/workManagerTaskCommitment/project/{projectId}_findByProjectId_10", "parameters":[ { "name":"projectId", "in":"path", "description":"The system-generated identifier of a project.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested task commitment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskCommitment-project-{projectId}-get", "x-filename-id":"workmanagertaskcommitment-project-projectid-get" } }, "/workManagerTaskCommitment/reason/{reasonId}":{ "get":{ "tags":[ "Task Commitment" ], "summary":"View all Task Commitments by Reason", "description":"This endpoint returns task commitments that meet the following requirements:
        • The object is associated with a reason with an ID value that matches the value of the {reasonId} path parameter.
        ", "operationId":"/workManagerTaskCommitment/reason/{reasonId}_findByReason", "parameters":[ { "name":"reasonId", "in":"path", "description":"The system-generated identifier of a reason.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested task commitment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskCommitment-reason-{reasonId}-get", "x-filename-id":"workmanagertaskcommitment-reason-reasonid-get" } }, "/workManagerTaskCommitment/user/{applicationUserId}":{ "get":{ "tags":[ "Task Commitment" ], "summary":"View all Task Commitments by Associated User", "description":"This endpoint returns task commitments that meet the following requirements:
        • The object is associated with an application user with an ID value that matches the value of the {applicationUserId} path parameter.
        ", "operationId":"/workManagerTaskCommitment/user/{applicationUserId}_findByTaskUser", "parameters":[ { "name":"applicationUserId", "in":"path", "description":"The system-generated identifier of an application user.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested task commitment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskCommitment-user-{applicationUserId}-get", "x-filename-id":"workmanagertaskcommitment-user-applicationuserid-get" } }, "/workManagerTaskCommitment/lastCommitment/task/{workManagerTaskId}":{ "get":{ "tags":[ "Task Commitment" ], "summary":"View Last Task Commitment ", "description":"This endpoint returns task commitments that meet the following requirements:
        • The object is associated with a task with an ID value that matches the value of the {workManagerTaskId} path parameter.
        ", "operationId":"/workManagerTaskCommitment/lastCommitment/task/{workManagerTaskId}_findLastCommitmentByTask", "parameters":[ { "name":"workManagerTaskId", "in":"path", "description":"The system-generated identifier of a task.", "required":true, "schema":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } } ], "responses":{ "404":{ "description":"The requested task commitment does not exist, or you do not have access to it." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"ApiEntityWorkManagerTaskCommitment", "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment", "exampleSetFlag":false }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskCommitment-lastCommitment-task-{workManagerTaskId}-get", "x-filename-id":"workmanagertaskcommitment-lastcommitment-task-workmanagertaskid-get" } }, "/workManagerTaskCommitment/parentCode":{ "get":{ "tags":[ "Task Commitment" ], "summary":"View all Task Commitments by Parent", "description":"Send a request to this endpoint to view all task commitments under parent with codes matching the code fields in query parameters.", "operationId":"/workManagerTaskCommitment/parentCode_getAllWorkManagerTaskCommitmentByParentCode", "parameters":[ { "name":"workspaceCode", "in":"query", "description":"The user-specified identifier of a workspace.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"projectCode", "in":"query", "description":"The user-specified identifier of a project.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"activityCode", "in":"query", "description":"The user-specified identifier of an activity.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } }, { "name":"taskName", "in":"query", "description":"The user-specified identifier of a task.
        This is a required field.", "required":true, "schema":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] } } ], "responses":{ "404":{ "description":"The requested task commitment does not exist, or you do not have access to it." }, "204":{ "description":"Successful operation with no content." }, "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "title":"List", "type":"array", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment", "exampleSetFlag":false }, "types":[ "array" ] }, "exampleSetFlag":false } } } }, "x-internal-id":"workManagerTaskCommitment-parentCode-get", "x-filename-id":"workmanagertaskcommitment-parentcode-get" } } }, "components":{ "schemas":{ "ApiEntityScheduleJob":{ "title":"ApiEntityScheduleJob", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "jobStatus":{ "type":"string", "description":"The status of the background service.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_RAN_YET", "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ] }, "jobId":{ "type":"integer", "description":"The unique identifier for the background service.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "jobKey":{ "type":"integer", "description":"The unique identifier for a job.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBaseline":{ "title":"ApiEntityBaseline", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"Identifies the official and unofficial baselines.
        Original: A copy of the original project schedule, against which you can evaluate project progress. The original baseline locks down all original values. It marks the starting point for requiring change requests for modifications to Scope Items, Work Packages, and Scope Assignments.
        Current: A copy of the latest project schedule. It can only be set when there is an original baseline. This is also referred to as the active baseline.
        Other: A third official baseline that can be used for any purpose.
        Blank: A blank field indicates this is an unofficial baseline, which could become an official baseline if desired.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CURRENT", "OTHER", "NONE" ] }, "name":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "time":{ "type":"string", "description":"The time at which the snapshot was generated. Allowed format is \"yyyy-MM-dd'T'HH:mm:ss.Z\".", "format":"date-time", "exampleSetFlag":false }, "overlayId":{ "type":"integer", "description":"The system-generated identifier of a baseline.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "dataDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBaselineId":{ "type":"integer", "description":"The system-generated identifier of a baseline.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineCategoryId":{ "type":"integer", "description":"The system-generated unique identifier of a baseline category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the baseline category.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the baseline process. Valid values are: In Progress, Failed, and Complete.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IN_PROGRESS", "FAILED", "COMPLETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBaselineInput":{ "title":"ApiEntityBaselineInput", "required":[ "name", "projectId" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"Identifies the official and unofficial baselines.
        Original: A copy of the original project schedule, against which you can evaluate project progress. The original baseline locks down all original values. It marks the starting point for requiring change requests for modifications to Scope Items, Work Packages, and Scope Assignments.
        Current: A copy of the latest project schedule. It can only be set when there is an original baseline. This is also referred to as the active baseline.
        Other: A third official baseline that can be used for any purpose.
        Blank: A blank field indicates this is an unofficial baseline, which could become an official baseline if desired.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CURRENT", "OTHER", "NONE" ] }, "name":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "time":{ "type":"string", "description":"The time at which the snapshot was generated. Allowed format is \"yyyy-MM-dd'T'HH:mm:ss.Z\".", "format":"date-time", "exampleSetFlag":false }, "sourceType":{ "type":"string", "description":"Source of the baseline. Default value is CURRENT_SCHEDULE.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FROM_HISTORY", "BASELINE", "SCENARIO", "CURRENT_SCHEDULE" ] }, "sourceName":{ "maxLength":255, "type":"string", "description":"Name of baseline or scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "dataDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBaselineId":{ "type":"integer", "description":"The system-generated identifier of a baseline.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineCategoryId":{ "type":"integer", "description":"The system-generated unique identifier of a baseline category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the baseline category.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the baseline process. Valid values are: In Progress, Failed, and Complete.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IN_PROGRESS", "FAILED", "COMPLETE" ] } }, "description":"This entity represents a Baseline object, a unique Baseline object can be identified by the following combinations of the fields.
        • projectBaselineId
        • name,projectId
        • name,projectCode,workspaceCode
          • ", "exampleSetFlag":false }, "ApiEntityCapitalPlanSnapshot":{ "title":"ApiEntityCapitalPlanSnapshot", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"Identifies the type of the baseline. Valid values are Original, Current, or Blank. Original baselines mark the starting point for recurring change requests for modifications to Scope Items, Work Packages, and Scope Assignments. Current baselines indicate the latest set baseline when a related original baseline exists. Blank baselines indicate the baseline is a snapshot.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL_PLAN", "PROJECT", "PROGRAM", "IDEA" ] }, "time":{ "type":"string", "description":"The time at which the snapshot was generated.", "format":"date-time", "exampleSetFlag":false }, "snapshotId":{ "type":"integer", "description":"The unique identifier for a baseline or snapshot.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "snapshotCode":{ "maxLength":255, "type":"string", "description":"Code for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "capitalPlanId":{ "type":"integer", "description":"The unique identifier of a budget plan.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCapitalPlanSnapshotInput":{ "title":"ApiEntityCapitalPlanSnapshotInput", "type":"object", "properties":{ "name":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "snapshotId":{ "type":"integer", "description":"The unique identifier for a baseline or snapshot.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "capitalPlanId":{ "type":"integer", "description":"The unique identifier of a budget plan.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProjectSnapshot":{ "title":"ApiEntityProjectSnapshot", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"Identifies the type of the baseline. Valid values are Original, Current, or Blank. Original baselines mark the starting point for recurring change requests for modifications to Scope Items, Work Packages, and Scope Assignments. Current baselines indicate the latest set baseline when a related original baseline exists. Blank baselines indicate the baseline is a snapshot.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL_PLAN", "PROJECT", "PROGRAM", "IDEA" ] }, "time":{ "type":"string", "description":"The time at which the snapshot was generated.", "format":"date-time", "exampleSetFlag":false }, "snapshotId":{ "type":"integer", "description":"The unique identifier for a baseline or snapshot.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "snapshotCode":{ "maxLength":255, "type":"string", "description":"Code for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectSnapshotInput":{ "title":"ApiEntityProjectSnapshotInput", "required":[ "projectId" ], "type":"object", "properties":{ "name":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "snapshotId":{ "type":"integer", "description":"The unique identifier for a baseline or snapshot.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityJobDetail":{ "title":"ApiEntityJobDetail", "type":"object", "properties":{ "jobStatus":{ "type":"string", "description":"The status of the background service.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_RAN_YET", "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ] }, "lastStartDate":{ "type":"string", "description":"The date and time the last job was executed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lastCompletionDate":{ "type":"string", "description":"The date the background service was last performed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "jobId":{ "type":"integer", "description":"The unique identifier for the background service.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "jobType":{ "type":"string", "description":"The type of a job.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MONTHLY", "DAILY", "FLEX_COLUMN_DELETE", "SCHEDULE_MONTE_CARLO", "SCHEDULE_MONTE_CARLO_LARGE", "SCHEDULE_MONTE_CARLO_EXPRESS", "SCHEDULE_MONTE_CARLO_ULTRALARGE", "GATEWAY_SYNC_JOB", "USER_DEFINED_REPORT", "LEVEL", "SCHEDULE_SCHEDULER", "SCHEDULE_SCHEDULER_EXPRESS", "APPLY_ACT_UNCERTAINTY", "RECALCULATE_SCHEDULE_COST", "STORE_PERIOD_PERFORMANCE", "SETUP_STORE_PERIOD_PERFORMANCE", "CALCULATE_PROJECT_SPREADS", "CALCULATE_ASSIGNMENT_SPREADS", "CALCULATE_ACTIVITY_SPREADS", "REPLACE_RESOURCES", "RUN_GLOBAL_CHANGE", "WORK_RATE_SYNC_TENANT", "WORK_RATE_SYNC_WORKSPACE", "RECALCULATE_COST", "RECALCULATE_PROJECTS_COST", "RECALCULATE_WORKSPACE_COST", "RECALCULATE_PROGRAM_COST", "CALCULATE_PROG_PROJ_COST_CURVE", "CREATE_SCENARIO", "IMPORT_FROM_P6", "P6_IMPORT_MIGRATION_JOB", "IMPORT_XER_FROM_P6", "IMPORT_FROM_P6_API", "IMPORT_XER_FROM_P6_API", "IMPORT_SCHEDULE_RECALCULATION", "EXPORT_TO_P6", "EXPORT_XER_TO_P6", "EXPORT_TO_MSP", "GATEWAY_SYNC_MASTER_DATA", "MEASURES_BY_PORTFOLIO_CALC", "MEASURE_BY_PERIOD_CALC", "MEASURES_BY_STRATEGY_CALC", "MEASURES_BY_PROJECT_CALC", "PROJECT_MEASURES_BY_WORKSPACE_CALC", "PROJECT_MEASURES_BY_PORTFOLIO_CALC", "PROGRAM_MEASURES_BY_WORKSPACE_CALC", "PROGRAM_MEASURES_BY_PORTFOLIO_CALC", "PROJECT_ACTUALS_EXCEL_IMPORT", "SCOPE_ASSIGNMENT_EXCEL_IMPORT", "FUND_EXCEL_IMPORT", "PORTFOLIO_FUND_EXCEL_IMPORT", "WORKSPACE_ROLE_EXCEL_IMPORT", "TASKS_EXCEL_IMPORT", "ASSIGN_RISK_MATRIX_TO_PROJECT", "RISKS_EXCEL_IMPORT", "RISK_IMPACT_RECALCULATION", "PROG_RISKS_EXCEL_IMPORT", "SYNC_ACTIVITY_BASED_RISK_DATA", "BUDGET_EXCEL_IMPORT", "PROG_BUDGET_EXCEL_IMPORT", "PROJECT_DELETE", "PORTFOLIO_AUTO_REFRESH", "RESOURCE_SCENARIO_APPROVAL", "RESOURCE_SCENARIO_DELETE", "RESOURCE_SCENARIO_PROPOSE", "WBS_EXCEL_IMPORT", "WBS_DELETE_WITH_ACTIVITIES_TASKS", "PROJECT_ACTIVITY_EXCEL_IMPORT", "RESOURCE_SCENARIO_COST_REFRESH", "PROJECT_DEMAND_COST_REFRESH", "PROJECT_CASHFLOW_RESOURCE_COST_REFRESH", "PROJECT_DEMAND_ASSIGNMENT_FETCH", "SUBMITTAL_EXCEL_IMPORT", "WORKSPACE_RESOURCE_EXCEL_IMPORT", "PROJECT_RESOURCE_EXCEL_IMPORT", "PROJECT_ROLE_EXCEL_IMPORT", "SUBJECT_AREA_REFRESH", "RECOMPUTE_STRATEGIC_ALIGN_SCORE", "PROJECT_SCHEDULE_HEALTH_UPGRADE", "RECALCULATE_SCHEDULE_HEALTH", "BUDGET_SCENARIO_APPROVAL", "COPY_WORKSPACE", "SET_ACTIVITY_SCENARIO", "MERGE_ACTIVITIES", "ACTIVITY_RESOURCE_SYNC", "PROJECT_EXCEL_IMPORT", "SCENARIO_EXCEL_IMPORT", "BUDGET_SCENARIO_OPTIMIZATION", "RESOURCE_SCENARIO_OPTIMIZATION", "USER_MIGRATION_EXPORT", "USER_MIGRATION_IMPORT", "GLOBAL_AUTH_MIGRATION_EXPORT", "GLOBAL_AUTH_MIGRATION_IMPORT", "CONFIG_MIGRATION_EXPORT", "CONFIG_MIGRATION_IMPORT", "RECALCULATE_TASK_SUMMARY_CHECK", "PROJECT_YEARLY_COSTS_EXCEL_IMPORT", "PROJECT_QUARTERLY_COSTS_EXCEL_IMPORT", "PROJECT_MONTHLY_COSTS_EXCEL_IMPORT", "PROGRAM_YEARLY_COSTS_EXCEL_IMPORT", "PROGRAM_QUARTERLY_COSTS_EXCEL_IMPORT", "PROGRAM_MONTHLY_COSTS_EXCEL_IMPORT", "RECALCULATE_FUNCTION", "RECALCULATE_FUNCTION_SEGMENT", "RECALCULATE_FUNCTION_SEGMENT_OVERLAY", "RECALCULATE_FUNCTIONS_FOR_SCHEDULER", "RECALCULATE_FUNCTIONS_FOR_EXCEL_IMPORT", "MIGRATE_TENANT_TO_LOBBY", "RENUMBER_ACTIVITY", "PC_MIGRATION", "COMPANY_MIGRATION_EXPORT", "COMPANY_MIGRATION_IMPORT", "CUSTOM_LOG_EXCEL_IMPORT", "PORTFOLIO_PRIORITIZATION_MATRIX_EXCEL_IMPORT", "WEATHER_MONTE_CARLO", "PROGRAM_DELETE", "PROGRAM_PROJECT_FILTER", "PROGRAM_EXCEL_IMPORT", "PROJECT_MOVE", "PROGRAM_SECURITY_SYNC", "IDEA_SECURITY_SYNC", "IDEA_SECURITY_MIGRATION", "IDEA_USERLINK_MIGRATION", "WORKSPACE_DELETE", "WORKSPACE_HARD_DELETE", "WORKSPACE_MOVE", "CASHFLOW_MIGRATION", "CBS_SYNC", "EVALUATION_REFRESH", "SCHEDULE_COMPARISON_EXPORT", "PROJECT_MOVE_RECALCULATE_FUNCTION", "PROJECT_MOVE_RECALCULATE_FUNCTION_SEGMENT", "PROJECT_MOVE_RECALCULATE_FUNCTION_SEGMENT_OVERLAY", "WORKSPACE_EXCHANGE_RATE_REFRESH", "TASK_COPY_PASTE_WITH_HANDOFF", "EXPORT_SPREAD_TO_EXCEL", "SCENARIO_LINK_ALL", "P6_IMPORT_MIGRATION_RECALCULATE_FUNCTION_JOB", "SCENARIO_LINK_ALL_SEGMENT", "EXTRACT_CASHFLOW_DATA", "MIGRATE_TASK_CARD_SETTINGS", "APPLY_SHC_TO_WORKSPACES", "APPLY_SHC_TO_PROJECTS" ] }, "jobLog":{ "maxLength":4000, "type":"string", "description":"Log of the job.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWBSImportResponse":{ "title":"ApiEntityWBSImportResponse", "type":"object", "properties":{ "sourceWBSId":{ "type":"integer", "description":"The system-generated unique identifier for the source WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceWBSName":{ "maxLength":255, "type":"string", "description":"The name of the source WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "targetWBSId":{ "type":"integer", "description":"The system-generated unique identifier for the target WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "targetWBSName":{ "maxLength":255, "type":"string", "description":"The name of the target WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "targetProjectName":{ "maxLength":255, "type":"string", "description":"The name of the project under which the target WBS is present.", "exampleSetFlag":false, "types":[ "string" ] }, "targetProjectId":{ "type":"integer", "description":"The system-generated unique identifier for the project under which the target WBS is present.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "warningMessage":{ "type":"string", "description":"The message generated when the import request did not complete in the allocated time and continues to run in the background. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceProjectName":{ "maxLength":255, "type":"string", "description":"The name of the project under which the source WBS is present.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceProjectId":{ "type":"integer", "description":"The system-generated unique identifier for the project under which the source WBS is present.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityWBSImportIdentifierInput":{ "title":"ApiEntityWBSImportIdentifierInput", "type":"object", "properties":{ "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"Unique identifier of the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsPath":{ "maxLength":4000, "type":"string", "description":"The complete path to the WBS. This is the hierarchy path from the Project Code to the WBS. It is based on the following pattern: <ProjectCode>.<WSBCode>.<WSBCode>...<WBSCode>. For example, for a project with code 'P1' having the WBS hierarchy as 'WBS1', 'WBS2', and 'WBS3', the wbsPath for 'WBS3' will be defined as 'P1.WBS1.WBS2.WBS3'.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWBSImportInput":{ "title":"ApiEntityWBSImportInput", "type":"object", "properties":{ "sourceWBS":{ "description":"The identifier for the source WBS.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityWBSImportIdentifierInput" } ] }, "targetWBS":{ "description":"The identifier for the target WBS.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityWBSImportIdentifierInput" } ] }, "copyOptions":{ "type":"array", "description":"The list of objects to be copied from the source WBS to the target WBS.
          ACTIVITIES must be selected to copy other objects associated with the WBS. If ACTIVITIES is not selected, then only the WBS will be copied.
          TASKS must be selected to copy TASK_HANDOFFS. If TASKS and ACTIVITIES are not selected along with TASK_HANDOFFS, the TASK_HANDOFFS will not be copied.
          Allowed Values : [ \"ACTIVITIES\", \"PROJECT_CODES\", \"WORKSPACE_CODES\", \"CONFIGURED_FIELDS\", \"RELATIONSHIPS\", \"ASSIGNMENTS\", \"TASKS\", \"TASK_HANDOFFS\"].", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityLevelerOption":{ "title":"ApiEntityLevelerOption", "required":[ "isLevelingMethodRole", "projectId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "preserveSchedDates":{ "type":"boolean", "description":"Preserves the early and late dates that were calculated during project scheduling when leveling a project. ", "exampleSetFlag":false, "types":[ "boolean" ] }, "resourceOrRoles":{ "uniqueItems":true, "type":"array", "description":"Option to enable leveling by resource or leveling by role.", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "priorities":{ "type":"array", "description":"Prioritizes resources and roles during leveling and used when more than one activity competes for the same resource or role at the same time.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityLevelingPriority", "exampleSetFlag":false }, "types":[ "array" ] }, "isLevelingMethodRole":{ "type":"boolean", "description":"Whether the leveling method role is for Leveler option.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityLevelingPriority":{ "title":"ApiEntityLevelingPriority", "required":[ "field", "order" ], "type":"object", "properties":{ "field":{ "maxLength":4000, "type":"string", "description":"Fields to be used to prioritize resources or roles during leveling.", "exampleSetFlag":false, "types":[ "string" ] }, "order":{ "type":"string", "description":"The order in which to level resources or roles for the fields chosen for priority.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ASCENDING", "DESCENDING", "SEQUENTIAL", "HIERARCHICAL" ] } }, "exampleSetFlag":false }, "ApiEntityProjectScheduleInput":{ "title":"ApiEntityProjectScheduleInput", "type":"object", "properties":{ "dataDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityApplyActivityUncertainty":{ "title":"ApiEntityApplyActivityUncertainty", "required":[ "distributionShape", "projectId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "overwriteExisting":{ "type":"boolean", "description":"If true, activity uncertainty fields will be overwritten.", "exampleSetFlag":false, "types":[ "boolean" ] }, "mostLikelyDuration":{ "type":"number", "description":"The estimated most likely amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "distributionShape":{ "type":"string", "description":"The probability distribution that best models the three-point estimate durations.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "minDuration":{ "type":"number", "description":"The estimated least amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.", "format":"double", "exampleSetFlag":false }, "maxDuration":{ "type":"number", "description":"The estimated maximum amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The ID of the project that the activity is in.", "format":"int64", "readOnly":true, "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityReportOverridesInput":{ "title":"ApiEntityReportOverridesInput", "required":[ "reportCode", "workspaceId" ], "type":"object", "properties":{ "format":{ "type":"string", "description":"The default output format for the report. The valid values are HTML, Excel, PDF, RTF, and XML.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PDF", "EXCEL", "XLSX", "HTML", "RTF", "XML" ] }, "reportId":{ "type":"integer", "description":"The system-generated identifier of a report.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "includeDescendants":{ "type":"boolean", "description":"Indicates whether or not the report includes its descendants.", "exampleSetFlag":false, "types":[ "boolean" ] }, "portfolio":{ "description":"This field represents the portfolio in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/PortfolioIdentifier" } ] }, "orientation":{ "type":"string", "description":"The page orientation of a report.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PORTRAIT", "LANDSCAPE" ] }, "reportCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the report.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "project":{ "description":"This field represents the project in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ProjectIdentifier" } ] }, "program":{ "description":"This field represents the program in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ProgramIdentifier" } ] } }, "description":"This entity represents a ReportOverrides object, a unique ReportOverrides object can be identified by the following combinations of the fields.
          • reportId
          • reportCode,workspaceId
          • reportCode,workspaceCode
            • ", "exampleSetFlag":false }, "PortfolioIdentifier":{ "title":"PortfolioIdentifier", "type":"object", "properties":{ "name":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProgramIdentifier":{ "title":"ProgramIdentifier", "type":"object", "properties":{ "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProjectIdentifier":{ "title":"ProjectIdentifier", "type":"object", "properties":{ "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloSettingsInput":{ "title":"ApiEntityMonteCarloSettingsInput", "type":"object", "properties":{ "checkConvergenceIterationFrequency":{ "type":"integer", "description":"The number of iterations for which the mean plan finish date must remain constant to be considered converged.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloSettingsId":{ "type":"integer", "description":"The unique identifier of a set of Monte Carlo settings.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "responseContext":{ "type":"string", "description":"The type of risk analysis run on a project.
            • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
            • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
            • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
            ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] }, "iterations":{ "type":"integer", "description":"The number of iterations run during the risk analysis.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "includeProposedItems":{ "type":"boolean", "description":"Controls whether the risk analysis includes risks with a status of Proposed.", "exampleSetFlag":false, "types":[ "boolean" ] }, "optimisticPercentile":{ "type":"integer", "description":"The value (0% to 100%) to be used to calculate optimistic percentiles.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "pessimisticPercentile":{ "type":"integer", "description":"The value (0% to 100%) to be used to calculate pessimistic percentiles.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "randomSeed":{ "type":"integer", "description":"Defines the number to be used to set the starting point for the random number generator.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "runRiskRemovalImpact":{ "type":"boolean", "description":"Select this option to run a risk removal impact analysis on the project. A risk removal impact analysis measures and ranks the potential impact of each risk on the cost and completion date of the entire project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "useConvergence":{ "type":"boolean", "description":"Controls whether convergence is used to automatically determine when enough iterations have been run during the risk analysis. As a risk analysis is performed, the results begin to converge to such an extent that there is no point running the analysis any further because the results are only changing by a small percentage. At this point, the analysis has converged and is automatically stopped. If this option is selected, the analysis is run until the convergence criteria that have been set up are met.", "exampleSetFlag":false, "types":[ "boolean" ] }, "convergenceThreshold":{ "type":"number", "description":"The maximum percentage deviation at which analysis results are considered converged.", "format":"double", "exampleSetFlag":false }, "activitySelection":{ "type":"string", "description":"Determines the activities that are included in the risk analysis results. Selecting all the activities will increase the risk analysis time.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT_ONLY", "MILESTONE_LOE", "ALL" ] }, "scheduleCost":{ "type":"boolean", "description":"Select this option to run a risk analysis where activity costs vary for each iteration. This will increase the risk analysis time. If this option is not selected, the activity costs will remain fixed for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a MonteCarloSettings object, a unique MonteCarloSettings object can be identified by the following combinations of the fields.
            • monteCarloSettingsId
            • projectId
            • projectCode,workspaceCode
              • ", "exampleSetFlag":false }, "ApiEntityDemandSchedule":{ "title":"ApiEntityDemandSchedule", "required":[ "projectCode", "workspaceCode" ], "type":"object", "properties":{ "keepExistingDemands":{ "type":"boolean", "description":"Keep existing demands.", "exampleSetFlag":false, "types":[ "boolean" ] }, "deleteUnmatchedRole":{ "type":"boolean", "description":"delete unmatched role. ", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityWorkRateSync":{ "title":"ApiEntityWorkRateSync", "required":[ "workspaceId" ], "type":"object", "properties":{ "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityActivityAggregate":{ "title":"ApiEntityActivityAggregate", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "baselinePlannedLaborUnits":{ "type":"number", "description":"The planned number of units for all labor resources assigned to the activity in the project baseline.", "format":"double", "exampleSetFlag":false }, "baselinePlannedNonLaborUnits":{ "type":"number", "description":"The planned units for all nonlabor resources assigned to the activities in the project baseline.", "format":"double", "exampleSetFlag":false }, "schedulePerfIndexLaborUnits":{ "type":"number", "description":"The ratio of the earned value of labor units to the planned value of labor units. Calculated as earned value labor units divided by planned value labor units.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scheduleVarIndexLaborUnits":{ "type":"number", "description":"The ratio of schedule variance labor units and the planned value labor units. Calculated as schedule variance labor units divided by planned value labor units. ", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "atCompletionNonLaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all nonlabor resources assigned to the activity. If the activity is not started, this value is equal to the activity planned nonlabor units. If the activity is completed, this value is equal to the activity actual nonlabor units. Calculated as actual nonlabor units and remaining nonlabor units. This field is non editable for 'START_MILESTONE', 'FINISH_MILESTONE' type activities.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodLaborUnits":{ "type":"number", "description":"The number of labor units used during this financial period.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodNonLaborUnits":{ "type":"number", "description":"The number of nonlabor units used during this financial period.", "format":"double", "exampleSetFlag":false }, "accountingVarianceLaborUnits":{ "type":"number", "description":"The difference between the planned value of work scheduled and the actual work performed.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceLaborUnits":{ "type":"number", "description":"The difference between the earned value of work performed and the work scheduled to be performed. Calculated as earned value labor units minus planned value labor units.", "format":"double", "exampleSetFlag":false }, "estimateToCompletionLaborUnits":{ "type":"number", "description":"The estimated quantity to complete the activity.", "format":"double", "exampleSetFlag":false }, "varianceAtCompletionLaborUnits":{ "type":"number", "description":"The difference between the baseline planned total labor units and the estimate at completion labour units. Calculated as project baseline total labor units minus estimate at completion labor units.", "format":"double", "exampleSetFlag":false }, "estimateAtCompletionLaborUnits":{ "type":"number", "description":"The estimated labor units at completion of the activity. Calculated as actual labor units plus estimated to completion labor units.", "format":"double", "exampleSetFlag":false }, "lateStart":{ "type":"string", "description":"The latest possible date the remaining work for the activity can begin without delaying the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lateFinish":{ "type":"string", "description":"The latest possible date the activity can finish without delaying the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyStart":{ "type":"string", "description":"The earliest possible date the remaining work for the activity can begin. ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyFinish":{ "type":"string", "description":"The earliest possible date the remaining work for the activity can begin. ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinish":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to end.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStart":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to begin.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "expectedFinish":{ "type":"string", "description":"The date work on the activity is expected to end.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStart":{ "type":"string", "description":"The latest possible date the remaining work for the activity must begin without delaying the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinish":{ "type":"string", "description":"The latest possible date the activity must finish without delaying the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "floatPath":{ "type":"integer", "description":"Indicates which critical path the activity is on. An activity with a float path value of 1 is on the most critical path. Higher values indicate less critical paths.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineDuration":{ "type":"number", "description":"Total number of hours allotted to the activity in the project baseline.", "format":"double", "exampleSetFlag":false }, "activityAggregateId":{ "type":"integer", "description":"The unique identifier of a rollup.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rollupType":{ "type":"string", "description":"The type of rollup.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY_TO_WORK_PACKAGE", "ACTIVITY_TO_PROJECT" ] }, "referenceObjectId":{ "type":"integer", "description":"The unique identifier of an activity reference object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "constraintDate":{ "type":"string", "description":"Constraint date for the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedDuration":{ "type":"number", "description":"Expected amount of time required to complete an activity. Calculated using the activity's calendar. The duration is measured from the activity's planned start date to its planned finish date.", "format":"double", "exampleSetFlag":false }, "atCompletionLaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all labor resources assigned to the activity. If the activity is not started, this value is equal to the activity planned labor units. If the activity is completed, this value is equal to the activity actual labor units. Calculated as actual labor units plus remaining labor units. This field is non editable for 'START_MILESTONE', 'FINISH_MILESTONE' type activities.", "format":"double", "exampleSetFlag":false }, "completedWeight":{ "type":"number", "description":"The method used for calculating the scope percentage of completed items.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "recordCount":{ "type":"integer", "description":"The number of activities added to a project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedLaborUnits":{ "type":"number", "description":"Planned number of units for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "plannedNonLaborUnits":{ "type":"number", "description":"Planned units for all nonlabor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "remainingLaborUnits":{ "type":"number", "description":"Remaining units for all labor resources assigned to an activity. Reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborUnits":{ "type":"number", "description":"Remaining units for all nonlabor resources assigned to the activity. Reflects the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed there are zero remaining units.", "format":"double", "exampleSetFlag":false }, "actualLaborUnits":{ "type":"number", "description":"Number of units expended for all labor resources assigned to an activity.", "format":"double", "exampleSetFlag":false }, "actualNonLaborUnits":{ "type":"number", "description":"Number of nonlabor units that have been expended on the activity.", "format":"double", "exampleSetFlag":false }, "earnedValueLaborUnits":{ "type":"number", "description":"The portion of baseline labor units that are complete as of the project data value.", "format":"double", "exampleSetFlag":false }, "varLaborUnits":{ "type":"number", "description":"The difference between baseline labor units and at completion labor units.", "format":"double", "exampleSetFlag":false }, "varStartDate":{ "type":"number", "description":"The duration between the current project start date and the baseline start date.", "format":"double", "exampleSetFlag":false }, "varFinishDate":{ "type":"number", "description":"The duration between the current project finish date and the baseline project finish date.", "format":"double", "exampleSetFlag":false }, "varNonLaborUnits":{ "type":"number", "description":"The difference between the baseline nonlabor units and the at completion nonlabor units.", "format":"double", "exampleSetFlag":false }, "plannedValueLaborUnits":{ "type":"number", "description":"The portion of baseline labor units that are scheduled to be complete as of the project data date.", "format":"double", "exampleSetFlag":false }, "floatPathOrder":{ "type":"integer", "description":"The position of the activity on its critical path.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedStart":{ "type":"string", "description":"The date the activity is scheduled to begin.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The date the activity is scheduled to end if the activity has not started. It is calculated by the scheduler and will not change after the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The date work on the activity began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The date when the activity was completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineStartDate":{ "type":"string", "description":"Current start date of the activity in the project baseline.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineFinishDate":{ "type":"string", "description":"Current finish date for the activity in the project baseline.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The current start date of the activity. If the activity is started, this value is the activity actual start date. If the activity is not started, this value is the activity planned start date. ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The current finish date for the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"Total working time from the activity remaining start date to the remaining finish date.", "format":"double", "exampleSetFlag":false }, "actualDuration":{ "type":"number", "description":"Total working time from the activity actual start date to the actual finish date for completed activities, or the total working time from the actual start date to the data date for in progress activities.", "format":"double", "exampleSetFlag":false }, "atCompletionDuration":{ "type":"number", "description":"Total working time from the activity's current start date to the current finish date. If the activity is not started, the current start date is the activity planned start date and the current finish date is the activity planned finish date. If the activity is started, the current start date is the activity actual start date and the current finish date is either the activity remaining finish date or actual finish date.", "format":"double", "exampleSetFlag":false }, "freeFloat":{ "type":"number", "description":"Amount of time the activity can be delayed before delaying the start date of any successor activity.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "resumeDate":{ "type":"string", "description":"The date when a suspended task or activity is resumed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintDate":{ "type":"string", "description":"The date for the activity's secondary constraint, if the activity has a secondary constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "suspendDate":{ "type":"string", "description":"The date work temporarily stopped on an activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "totalFloat":{ "type":"number", "description":"Amount of time the activity can be delayed before delaying the project finish date. Calculated as late start minus early start or as late finish minus early finish.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "weight":{ "type":"number", "description":"The importance of the activity in relation to other activities.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityActivity":{ "title":"ApiEntityActivity", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "owner":{ "maxLength":255, "type":"string", "description":"The user responsible for the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "calendar":{ "type":"integer", "description":"The calendar assigned to the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityWorkManagerTaskDateStatus":{ "type":"string", "description":"The current state of task dates assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NO_TASK_DATES", "ALL_WITHIN", "AT_LEAST_ONE_OUTSIDE" ] }, "activityWorkManagerTaskStatus":{ "type":"string", "description":"The current status of the task assigned to the activity. Valid values are New, Pending, Committed, and Completed.
              This is a read-only field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NO_TASKS", "ACTIVITY_COMPLETE_TASKS_NOT", "TASKS_COMPLETE_ACTIVITY_NOT", "BOTH_COMPLETE", "BOTH_NOT_COMPLETE" ] }, "activityWorkManagerTaskStatusIndicator":{ "type":"boolean", "description":"Indicates whether any of the activity's assigned tasks have dates or completion statuses that requires attention.
              This is a read-only field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "durationPercentOfPlanned":{ "type":"number", "description":"The actual duration percent of planned duration for the activity. Calculated as Actual Duration divided by Original BL Duration multiplied by 100.", "format":"double", "exampleSetFlag":false }, "nonLaborUnitsCompletePercent":{ "type":"number", "description":"The percent complete of units for all nonlabor resources for the activity. Calculated as Actual Nonlabor Units divided by At Completion Nonlabor Units multiplied by 100.", "format":"double", "exampleSetFlag":false }, "laborUnitsCompletePercent":{ "type":"number", "description":"The percent complete of units for all labor resources for the activity. Calculated as Actual Labor Units divided by At Completion Labor Units multiplied by 100.", "format":"double", "exampleSetFlag":false }, "schedulePerfIndexLaborUnits":{ "type":"number", "description":"The ratio of the earned value of labor units to the planned value of labor units.
              Calculated as Earned Value Labor Units divided by Planned Value Labor Units.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scheduleVarIndexLaborUnits":{ "type":"number", "description":"The ratio of schedule variance labor units and the planned value labor units.
              Calculated as Schedule Variance Labor Units divided by Planned Value Labor Units.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "atCompletionBudgetLaborUnits":{ "type":"number", "description":"The planned total labor units through activity completion.", "format":"double", "exampleSetFlag":false }, "atCompletionNonLaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all nonlabor resources assigned to the activity.
              It is the same as the planned nonlabor units if the activity is not started, and the actual nonlabor units after the activity is completed.
              Calculated as Actual Nonlabor Units plus Remaining Nonlabor Units.", "format":"double", "exampleSetFlag":false }, "percentCompleteWeightedBy":{ "type":"string", "description":"The method used to calculate the scope percentage completion for scope assignments. The weight is calculated using cost, quantity, hours, or manually entered values.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COST", "QUANTITY", "HOURS", "MANUAL" ] }, "actualThisPeriodLaborUnits":{ "type":"number", "description":"The number of labor units used during this financial period.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodNonLaborUnits":{ "type":"number", "description":"The nonlabor units used during this financial period.", "format":"double", "exampleSetFlag":false }, "performancePercentComplete":{ "type":"number", "description":"The percentage of the planned work that is currently complete.
              Performance Percent Complete is used to calculate earned value and is equal to the activity percent complete.", "format":"double", "exampleSetFlag":false }, "accountingVarianceLaborUnits":{ "type":"number", "description":"The difference between the planned value of work scheduled and the actual work performed.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceLaborUnits":{ "type":"number", "description":"The difference between the earned value of work performed and the work scheduled to be performed.
              Calculated as Earned Value Labor Units minus Planned Value Labor Units.", "format":"double", "exampleSetFlag":false }, "estimateToCompletionLaborUnits":{ "type":"number", "description":"The estimated number of labor units required to complete the activity.
              Calculated as the Remaining Total Units for the activity.", "format":"double", "exampleSetFlag":false }, "varianceAtCompletionLaborUnits":{ "type":"number", "description":"The difference between the baseline planned total labor units and the estimate at completion labor units.
              Calculated as Project Baseline Planned Total Labor Units minus Estimate At Completion Labor Units.", "format":"double", "exampleSetFlag":false }, "estimateAtCompletionLaborUnits":{ "type":"number", "description":"The estimated labor units at completion.
              Calculated as Actual Labor Units plus Estimate To Complete Labor Units. Estimate To Complete Labor Units is calculated based off of the Earned Value setting.", "format":"double", "exampleSetFlag":false }, "workManagerTaskPlannedOutsideCount":{ "type":"integer", "description":"The number of planned tasks assigned to the activity whose Start or Finish dates fall outside of the activity's Start or Finish dates.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskPlannedCompleteCount":{ "type":"integer", "description":"The number of planned tasks assigned to the activity that are completed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskPlannedNotCompleteCount":{ "type":"integer", "description":"The number of planned tasks assigned to the activity that are not completed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskUnplannedCount":{ "type":"integer", "description":"The number of unplanned tasks assigned to the activity that are not completed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costVarianceLaborUnitsIndex":{ "type":"number", "description":"The ratio of the cost variance labor units and the earned value labor units for the activity.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "schedulePerformanceIndex":{ "type":"number", "description":"The measure of work accomplished as a percentage of the work scheduled on the activity.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "toCompletePerformanceIndex":{ "type":"number", "description":"A measure of the value of the activity work that is remaining.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "priorActualNonLaborUnits":{ "type":"number", "description":"Prior Actual Nonlabor Units", "format":"double", "exampleSetFlag":false }, "costPerformanceIndexLaborUnits":{ "type":"number", "description":"The measure of a activity's cost efficiency in labor units.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "primaryResource":{ "type":"integer", "description":"The user designated as the primary resource for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityFinancial":{ "description":"An object containing the financial fields of an activity in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityFinancial" } ] }, "activityUncertainties":{ "type":"array", "description":"The uncertainties associated with an activity.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityUncertainty", "exampleSetFlag":false }, "types":[ "array" ] }, "lateStart":{ "type":"string", "description":"The latest possible date the remaining work for the activity can begin without delaying the project finish date.
              This date is calculated based on activity relationships, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lateFinish":{ "type":"string", "description":"The latest possible date the activity can finish without delaying the project finish date.
              This date is calculated based on activity relationships, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyStart":{ "type":"string", "description":"The earliest possible date the remaining work for the activity can begin.
              This date is calculated based on network logic, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyFinish":{ "type":"string", "description":"The earliest possible date the activity can finish.
              This date is calculated based on network logic, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinish":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to finish.
              If this activity is not started, this date is the planned finish. This date can be updated manually by the user, but it is overwritten when you schedule the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStart":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to begin.
              This date can be updated manually by the user. Before the activity is started, this date is the same as the planned start.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "expectedFinish":{ "type":"string", "description":"The date you expect work on the activity to finish.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStart":{ "type":"string", "description":"The latest possible date the remaining work for the activity must begin without delaying the project finish date.
              This date is calculated by the project scheduler based on activity relationship, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinish":{ "type":"string", "description":"The latest possible date the activity must finish without delaying the project finish date.
              This date is calculated by the project scheduler based on activity relationships, schedule constraints, and resource availability. When the activity is complete, this field is blank.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "floatPath":{ "type":"integer", "description":"Indicates which critical path the activity is on. An activity with a floatPath value of 1 is on the most critical path, whereas an activity with a floatPath value of 2 is on the second most critical path, and so on.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "originalBaselineFields":{ "description":"Activity fields available for the original baseline.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityBaselineFields" } ] }, "currentBaselineFields":{ "description":"Activity fields available in the current baseline.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityBaselineFields" } ] }, "otherBaselineFields":{ "description":"Activity fields available for baseline marked other.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityBaselineFields" } ] }, "userBaseline1Fields":{ "description":"Activity fields available for the current user's 1st baseline.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityBaselineFields" } ] }, "userBaseline2Fields":{ "description":"Activity fields available for the current user's 2nd baseline.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityBaselineFields" } ] }, "userBaseline3Fields":{ "description":"Activity fields available for the current user's 3rd baseline.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityBaselineFields" } ] }, "codeValuesActivity":{ "type":"array", "description":"The list of code values for an activity. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "wbscodes":{ "type":"array", "description":"List of WBS codes in hierarchy.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "resourceCodeList":{ "maxLength":930, "minLength":0, "type":"string", "description":"The unique identifiers of the resources assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceNameList":{ "maxLength":3855, "minLength":0, "type":"string", "description":"The names of the resources assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "roleCodeList":{ "maxLength":930, "minLength":0, "type":"string", "description":"The unique identifiers of the roles assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "roleNameList":{ "maxLength":3855, "minLength":0, "type":"string", "description":"The names of the roles assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "danglingFinish":{ "type":"boolean", "description":"An activity with a dangling finish has only SF or SS successors and therefore could have an unrealistic finish date. To avoid dangling finishes, ensure each activity has at least one FS or SS relationship as its successor.", "exampleSetFlag":false, "types":[ "boolean" ] }, "danglingStart":{ "type":"boolean", "description":"An activity with a dangling start has only SF or FF predecessors and therefore could have an unrealistic start date. To avoid dangling starts, ensure each activity has at least one FS or SS relationship as its predecessor.", "exampleSetFlag":false, "types":[ "boolean" ] }, "ffPredecessor":{ "type":"boolean", "description":"Finish-to-Finish (FF) relationships are acceptable to use in moderation.", "exampleSetFlag":false, "types":[ "boolean" ] }, "fsPredecessor":{ "type":"boolean", "description":"Finish-to-Start (FS) relationships are the easiest to trace and understand. The majority of your relationships should be FS.", "exampleSetFlag":false, "types":[ "boolean" ] }, "hardConstraint":{ "type":"boolean", "description":"Mandatory Start and Mandatory Finish are hard constraints that prevent activities from being scheduled according to logic and prevent delays from impacting succeeding activities. The effects of hard constraints become more noticeable as the schedule is progressed, and they generally should not be used.", "exampleSetFlag":false, "types":[ "boolean" ] }, "invalidProgressDate":{ "type":"boolean", "description":"Progress should be recorded before the Data Date, and planned work should be recorded after. Activities with invalid dates can affect the accuracy of the project schedule.", "exampleSetFlag":false, "types":[ "boolean" ] }, "largeDuration":{ "type":"boolean", "description":"Large duration activities are harder to manage and may lack sufficient detail. Consider dividing these activities into shorter, more discrete activities, which provide better insight into cost and schedule.", "exampleSetFlag":false, "types":[ "boolean" ] }, "largeFloat":{ "type":"boolean", "description":"Large float values may indicate missing activity relationships. Provide activities with reasonable logic to ensure a more stable project plan.", "exampleSetFlag":false, "types":[ "boolean" ] }, "lateActivity":{ "type":"boolean", "description":"Late activities indicate how well the project is performing against the earned value baseline.", "exampleSetFlag":false, "types":[ "boolean" ] }, "negativeFloat":{ "type":"boolean", "description":"Negative float usually indicates an activity constraint that cannot be met with the current schedule or progress has been made out of sequence. Corrective action should be taken to ensure activity dates are accurate and achievable.", "exampleSetFlag":false, "types":[ "boolean" ] }, "noPredecessor":{ "type":"boolean", "description":"An activity with no predecessors could be scheduled to start immediately. This can negatively impact your project schedule and should be avoided.", "exampleSetFlag":false, "types":[ "boolean" ] }, "noResource":{ "type":"boolean", "description":"Roles and resources detail the cost and labor of the work to be performed. An activity without roles or resources may be insufficiently planned.", "exampleSetFlag":false, "types":[ "boolean" ] }, "noSuccessor":{ "type":"boolean", "description":"An activity with no successor relationships could be delayed indefinitely without affecting project completion. Ensure all activities have at least one successor.", "exampleSetFlag":false, "types":[ "boolean" ] }, "openEnds":{ "type":"boolean", "description":"An activity without a predecessor or successor relationship may negatively affect the quality of your schedule and should be avoided.", "exampleSetFlag":false, "types":[ "boolean" ] }, "predecessorLag":{ "type":"boolean", "description":"Lag time between activities should not be used to control float or constrain dates. Consider representing the delay between two activities by adding another activity.", "exampleSetFlag":false, "types":[ "boolean" ] }, "predecessorNegativeLag":{ "type":"boolean", "description":"The use of negative lags to overlap activities or adjust successor dates can affect the critical path and distort total float. It can also cause a successor to start before a predecessor. Negative lags can cause activities to be scheduled in unrealistic ways and generally should not be used.", "exampleSetFlag":false, "types":[ "boolean" ] }, "sfPredecessor":{ "type":"boolean", "description":"Start-to-Finish (SF) relationship logic says the successor occurs before the predecessor. SF relationships are a poor practice and generally should not be used.", "exampleSetFlag":false, "types":[ "boolean" ] }, "softConstraint":{ "type":"boolean", "description":"Soft constraints allow the schedule to be logic driven but can distort float and create negative float.", "exampleSetFlag":false, "types":[ "boolean" ] }, "ssPredecessor":{ "type":"boolean", "description":"Start-to-Start (SS) relationships are acceptable to use in moderation.", "exampleSetFlag":false, "types":[ "boolean" ] }, "constraintDate":{ "type":"string", "description":"The constraint date for the activity, if the activity has a constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "activityPercentComplete":{ "type":"number", "description":"The percentage of the activity that has been completed.
              This value is based on the formula for the selected Percent Complete Type. The Percent Complete Type can be Physical, Duration, Units, or Scope.
              Physical: The user records the percent complete manually.
              Duration: Calculated as (Planned Duration minus Remaining Duration) divided by Planned Duration, multiplied by 100.
              Units: Calculated as (Actual Labor Units plus Actual Nonlabor Units) divided by (Actual Labor Units plus Actual Nonlabor Units plus Remaining Labor Units plus Remaining Nonlabor Units), multiplied by 100.
              Scope: Calculated as Installed Quantity divided by At Completion Quantity, multiplied by 100.", "format":"double", "exampleSetFlag":false }, "constraintType":{ "type":"string", "description":"The main restriction impacting the activity start or finish date.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "plannedDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The expected amount of time required to complete an activity.
              The planned working time is calculated using the activity's calendar. The duration is measured from the activity's planned start date to its planned finish date.", "format":"double", "exampleSetFlag":false }, "targetFinishDate":{ "type":"string", "description":"The Target Finish date for the activity used in Risk Analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "critical":{ "type":"boolean", "description":"Designates an activity as critical. An activity is defined as critical based upon the project settings configured for the project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workPackageId":{ "type":"integer", "description":"The unique identifier for the work package that the activity is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "durationType":{ "type":"string", "description":"Determines how remaining duration, units, and units/time are calculated when you update an activity that has resources assigned. The valid values are Fixed Units/Time, Fixed Units, Fixed Duration & Units, and Fixed Duration & Units/Time.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FIXED_RATE", "FIXED_QUANTITY", "FIXED_DURATION_AND_UNITS", "FIXED_DURATION" ] }, "scopePercentComplete":{ "type":"number", "description":"The percentage completion of the scope assignments linked to the activity.
              Calculated as Installed Quantity divided by At Completion Quantity.", "format":"double", "exampleSetFlag":false }, "percentCompleteType":{ "type":"string", "description":"Determines the way in which the application calculates the percent complete for the activity.
              Physical: Percent complete is manually entered by a user based on the amount of physical work completed on the activity.
              Duration: Percent complete is calculated from the actual and remaining duration.
              Units: Percent complete is calculated from the actual and remaining units.
              Scope: The percent complete for the activity is derived from the scope percent complete of the linked scope assignments.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PHYSICAL", "DURATION", "UNITS", "SCOPE" ] }, "atCompletionLaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all labor resources assigned to the activity.
              It is the same as the planned labor units if the activity is not started, and the actual labor units after the activity is completed.
              Calculated as Actual Labor Units plus Remaining Labor Units.", "format":"double", "exampleSetFlag":false }, "activityPriority":{ "type":"string", "description":"Determines the priority of the activity when performing role leveling.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TOP", "HIGH", "NORMAL", "LOW", "LOWEST" ] }, "physicalPercentComplete":{ "type":"number", "description":"The activity percent complete, manually entered by a user.", "format":"double", "exampleSetFlag":false }, "completedWeight":{ "type":"number", "description":"The weight of the activity percent completed value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "remainingFloat":{ "type":"number", "description":"The amount of time remaining in which the activity can be delayed before delaying the project finish date. Calculated as Late Finish minus Remaining Finish.", "format":"double", "exampleSetFlag":false }, "durationPercentComplete":{ "type":"number", "description":"The duration percent complete for the activity. Calculated as Planned Duration minus Remaining Duration divided by Planned Duration multiplied by 100.", "format":"double", "exampleSetFlag":false }, "recordCount":{ "type":"integer", "description":"The number of activities added to the project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedLaborUnits":{ "type":"number", "description":"The planned number of units for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "plannedNonLaborUnits":{ "type":"number", "description":"The planned units for all nonlabor resources assigned to the activities in the project.", "format":"double", "exampleSetFlag":false }, "remainingLaborUnits":{ "type":"number", "description":"The remaining units for all labor resources assigned to the activity.
              The Remaining Labor Units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborUnits":{ "type":"number", "description":"The remaining units for all nonlabor resources assigned to the activity.
              The remaining units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, there are zero remaining units.", "format":"double", "exampleSetFlag":false }, "schedulePercentComplete":{ "type":"number", "description":"The activity schedule percent complete specifies how much of the activity's project baseline duration is complete so far.
              With an earned value baseline selected, the schedule percent complete value is calculated based on where the current data date falls relative to the activity's project baseline start and finish dates.
              Calculated as (Data Date - Baseline Start Date) / (Baseline Finish Date - Baseline Start Date).
              If the data date is earlier than the baseline start, the schedule percent complete is 0. If the data date is later than the baseline finish, the schedule percent complete is 100.
              Without an earned value baseline selected, the schedule percent complete value will use the activity planned dates and will be calculated based on where the current data date falls relative each activity's planned start and finish dates.
              Calculated as (Data Date - Planned Start Date) / (Planned Finish Date - Planned Start Date).
              If the data date is earlier than the planned start, the schedule percent complete is 0. If the data date is later than the planned finish, the schedule percent complete is 100.", "format":"double", "exampleSetFlag":false }, "actualLaborUnits":{ "type":"number", "description":"The number of units expended for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "actualNonLaborUnits":{ "type":"number", "description":"The number of nonlabor units that have been expended on the activity.", "format":"double", "exampleSetFlag":false }, "unitsPercentComplete":{ "type":"number", "description":"The percent complete of units for all labor and nonlabor resources assigned to the activity. Calculated as Actual Units divided by At Completion Units multiplied by 100.", "format":"double", "exampleSetFlag":false }, "costVarianceLaborUnits":{ "type":"number", "description":"The difference between the earned value labor units and the actual labor units.", "format":"double", "exampleSetFlag":false }, "earnedValueLaborUnits":{ "type":"number", "description":"The portion of baseline labor units that are actually completed as of the project data date.
              Calculated as Budget At Completion Labor Units multiplied by Performance Percent Complete. The performance percent complete will be calculated using the activity percent complete.", "format":"double", "exampleSetFlag":false }, "varLaborUnits":{ "type":"number", "description":"The difference between baseline labor units and at completion labor units.
              ", "format":"double", "exampleSetFlag":false }, "varStartDate":{ "type":"number", "description":"The duration between the current project start date and the baseline start date.", "format":"double", "exampleSetFlag":false }, "varFinishDate":{ "type":"number", "description":"The duration between the current project finish date and the baseline project finish date.", "format":"double", "exampleSetFlag":false }, "varNonLaborUnits":{ "type":"number", "description":"The difference between the baseline nonlabor units and the at completion nonlabor units.", "format":"double", "exampleSetFlag":false }, "varDuration":{ "type":"number", "description":"The duration between the activity's duration and the at completion duration.", "format":"double", "exampleSetFlag":false }, "plannedValueLaborUnits":{ "type":"number", "description":"The portion of baseline labor units that are scheduled to be completed as of the project data date.
              Calculated as Budget At Completion Labor Units multiplied by Schedule Percent Complete.", "format":"double", "exampleSetFlag":false }, "floatPathOrder":{ "type":"integer", "description":"The position of the activity on its critical path.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskCount":{ "type":"integer", "description":"The number of tasks assigned to an activity.
              This is a read-only field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programMilestone":{ "type":"boolean", "description":"Display Milestone on Program.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costVarianceIndex":{ "type":"number", "description":"The ratio of the cost variance and the earned value of work performed on the WBS or activity.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scheduleVarianceIndex":{ "type":"number", "description":"The ratio of schedule variance and the work scheduled to be performed.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "priorActualLaborUnits":{ "type":"number", "description":"Prior Actual Labor Units", "format":"double", "exampleSetFlag":false }, "costPerformanceIndex":{ "type":"number", "description":"The measure of a activity's cost efficiency.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "plannedStart":{ "type":"string", "description":"The date the activity is scheduled to start.
              This date the activity is scheduled to begin is calculated by the project scheduler but can be updated manually by the project manager. This date cannot be changed by the project scheduler after the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The date the activity is scheduled to finish if the activity has not started.
              This date is calculated by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The date work on the activity began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The date when the activity was completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the activity relative to others within the view.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityStatus":{ "type":"string", "description":"Determines the status of the activity. Valid values are Not Started, In Progress, and Completed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "startDate":{ "type":"string", "description":"The current start date of the activity.
              For started activities, this is the actual start date. For not started activities, this is the planned start date until the project is scheduled. When scheduled, the start date field is set to the remaining early start date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The current finish date for the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The total working time from the activity remaining start date to the remaining finish date.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "activityName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "activityType":{ "type":"string", "description":"The type of activity. Valid values are Activity Dependent, Resource Dependent, Level of Effort, Start Milestone, and Finish Milestone.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "RESOURCE_DEPENDENT", "LEVEL_OF_EFFORT", "START_MILESTONE", "FINISH_MILESTONE", "WBS_SUMMARY" ] }, "actualDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The total working time from the activity Actual Start date to the Actual Finish date for completed activities, or the total working time from the Actual Start date to the data date for in-progress activities.
              The actual working time is computed using the activity's calendar.", "format":"double", "exampleSetFlag":false }, "atCompletionDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The total working time from the activity's current start date to the current finish date.
              The current start date is the planned start date until the activity is started, and then it is the actual start date. The current finish date is the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. The total working time is calculated using the activity's calendar.", "format":"double", "exampleSetFlag":false }, "drivingPath":{ "type":"boolean", "description":"The sequence of project activities from start to finish where the Total Duration is longer than any other path.", "exampleSetFlag":false, "types":[ "boolean" ] }, "freeFloat":{ "type":"number", "description":"The amount of time the activity can be delayed before delaying the start date of any successor activity.", "format":"double", "exampleSetFlag":false }, "resumeDate":{ "type":"string", "description":"The date when a suspended task or activity is resumed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintDate":{ "type":"string", "description":"The date for the activity's secondary constraint, if the activity has a secondary constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintType":{ "type":"string", "description":"The secondary restriction impacting the activity start or finish date.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "suspendDate":{ "type":"string", "description":"The date work has temporarily stopped on a given activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "totalFloat":{ "type":"number", "description":"The amount of time the activity can be delayed before delaying the project finish date. Calculated as Late Start minus Early Start or as Late Finish minus Early Finish.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for an activity.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "outOfSequence":{ "type":"boolean", "description":"Activities that progress out of sequence occur when a successor activity begins or completes before its predecessor finishes. This can lead to inaccurate timelines and project risks. Identify and correct out of sequence activities to ensure that the project schedule is accurate.", "exampleSetFlag":false, "types":[ "boolean" ] }, "starred":{ "type":"boolean", "description":"Specifies whether the activity has been marked as important.", "exampleSetFlag":false, "types":[ "boolean" ] }, "wbsId":{ "type":"integer", "description":"The WBS that the activity is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "weight":{ "type":"number", "description":"The importance of the activity in relation to other activities.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityActivityBaselineFields":{ "title":"ApiEntityActivityBaselineFields", "type":"object", "properties":{ "actualNonLaborCostProject":{ "type":"number", "description":"The actual cost for all nonlabor resources assigned to the activity as stored in the associated project baseline. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "actualMaterialCostProject":{ "type":"number", "description":"The actual cost for all material resources assigned to the activity as stored in the associated project baseline. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedNonLaborCostProject":{ "type":"number", "description":"The planned cost for all nonlabor resources assigned to the activity in the associated project baseline. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedMaterialCostProject":{ "type":"number", "description":"The planned cost for all material resources assigned to the activity in the associated project baseline. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "varianceLaborCostProject":{ "type":"number", "description":"The difference between the associated project baseline planned labor cost and the current schedule at completion labor cost. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "varianceNonLaborCostProject":{ "type":"number", "description":"The difference between the associated project baseline planned nonlabor cost and the current schedule at completion nonlabor cost. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "varianceMaterialCostProject":{ "type":"number", "description":"The difference between the associated project baseline planned material cost and the current schedule at completion material cost. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "varianceTotalCostProject":{ "type":"number", "description":"The difference between the associated project baseline planned labor, nonlabor, and material cost and the current schedule at completion labor, nonlabor, and material cost. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "unitPercentComplete":{ "type":"number", "description":"The percent complete of units for all labor and nonlabor resources assigned to the activity. Calculated as Actual Units divided by At Completion Units multiplied by 100.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "laborUnitVariance":{ "type":"number", "description":"The difference between baseline labor units and at completion labor units.
              ", "format":"double", "readOnly":true, "exampleSetFlag":false, "types":[ "number" ] }, "nonLaborUnitVariance":{ "type":"number", "description":"The difference between the baseline nonlabor units and the at completion nonlabor units.", "format":"double", "readOnly":true, "exampleSetFlag":false, "types":[ "number" ] }, "varianceLaborCost":{ "type":"number", "description":"The difference between the associated project baseline planned labor cost and the current schedule at completion labor cost. This field is in base currency and is calculated from varianceLaborCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "varianceNonLaborCost":{ "type":"number", "description":"The difference between the associated project baseline planned nonlabor cost and the current schedule at completion nonlabor cost. This field is in base currency and is calculated from varianceNonLaborCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "varianceMaterialCost":{ "type":"number", "description":"The difference between the associated project baseline planned material cost and the current schedule at completion material cost. This field is in base currency and is calculated from varianceMaterialCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "varianceTotalCost":{ "type":"number", "description":"The difference between the associated project baseline planned labor, nonlabor, and material cost and the current schedule at completion labor, nonlabor, and material cost. This field is in base currency and is calculated from varianceTotalCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "lateStart":{ "type":"string", "description":"The latest possible date the remaining work for the activity can begin without delaying the project finish date.
              This date is calculated based on activity relationships, schedule constraints, and resource availability.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "lateFinish":{ "type":"string", "description":"The latest possible date the activity can finish without delaying the project finish date.
              This date is calculated based on activity relationships, schedule constraints, and resource availability.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "earlyStart":{ "type":"string", "description":"The earliest possible date the remaining work for the activity can begin.
              This date is calculated based on network logic, schedule constraints, and resource availability.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "earlyFinish":{ "type":"string", "description":"The earliest possible date the activity can finish.
              This date is calculated based on network logic, schedule constraints, and resource availability.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinish":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to finish.
              If this activity is not started, this date is the planned finish. This date can be updated manually by the user, but it is overwritten when you schedule the project.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "remainingStart":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to begin.
              This date can be updated manually by the user. Before the activity is started, this date is the same as the planned start.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "durationVariance":{ "type":"number", "description":"The duration between the activity's duration and the at completion duration.", "format":"double", "readOnly":true, "exampleSetFlag":false, "types":[ "number" ] }, "constraintDate":{ "type":"string", "description":"The constraint date for the activity, if the activity has a constraint.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "activityPercentComplete":{ "type":"number", "description":"The percentage of the activity that has been completed.
              This value is based on the formula for the selected Percent Complete Type. The Percent Complete Type can be Physical, Duration, Units, or Scope.
              Physical: The user records the percent complete manually.
              Duration: Calculated as (Planned Duration minus Remaining Duration) divided by Planned Duration, multiplied by 100.
              Units: Calculated as (Actual Labor Units plus Actual Nonlabor Units) divided by (Actual Labor Units plus Actual Nonlabor Units plus Remaining Labor Units plus Remaining Nonlabor Units), multiplied by 100.
              Scope: Calculated as Installed Quantity divided by At Completion Quantity, multiplied by 100.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "constraintType":{ "type":"string", "description":"The main restriction impacting the activity start or finish date.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "plannedDuration":{ "type":"number", "description":"The expected amount of time required to complete an activity.
              The planned working time is calculated using the activity's calendar. The duration is measured from the activity's planned start date to its planned finish date.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "percentCompleteType":{ "type":"string", "description":"Determines the way in which the application calculates the percent complete for the activity.
              Physical: Percent complete is manually entered by a user based on the amount of physical work completed on the activity.
              Duration: Percent complete is calculated from the actual and remaining duration.
              Units: Percent complete is calculated from the actual and remaining units.
              Scope: The percent complete for the activity is derived from the scope percent complete of the linked scope assignments.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PHYSICAL", "DURATION", "UNITS", "SCOPE" ] }, "durationPercentComplete":{ "type":"number", "description":"The duration percent complete for the activity. Calculated as Planned Duration minus Remaining Duration divided by Planned Duration multiplied by 100.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedLaborUnits":{ "type":"number", "description":"The planned number of units for all labor resources assigned to the activity.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedNonLaborUnits":{ "type":"number", "description":"The planned units for all nonlabor resources assigned to the activities in the project.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "actualLaborUnits":{ "type":"number", "description":"The number of units expended for all labor resources assigned to the activity.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "actualNonLaborUnits":{ "type":"number", "description":"The number of nonlabor units that have been expended on the activity.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedNonLaborCost":{ "type":"number", "description":"The planned cost for all nonlabor resources assigned to the activity in the associated project baseline. This field is in base currency and is calculated from plannedNonLaborCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "actualTotalCost":{ "type":"number", "description":"The actual total cost for all labor, nonlabor, and material resources assigned to the activity as stored in the associated project baseline. This field is in base currency and is calculated from actualTotalCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedLaborCost":{ "type":"number", "description":"The planned cost for all labor resources assigned to the activity in the associated project baseline. This field is in base currency and is calculated from plannedLaborCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedMaterialCost":{ "type":"number", "description":"The planned cost for all material resources assigned to the activity in the associated project baseline. This field is in base currency and is calculated from plannedMaterialCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "actualLaborCost":{ "type":"number", "description":"The actual cost for all labor resources assigned to the activity as stored in the associated project baseline. This field is in base currency and is calculated from actualLaborCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "actualMaterialCost":{ "type":"number", "description":"The actual cost for all material resources assigned to the activity as stored in the associated project baseline. This field is in base currency and is calculated from actualMaterialCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedTotalCost":{ "type":"number", "description":"The expected total cost of the activity and includes all resources and direct activity costs (expenses) in the associated project baseline. This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "actualNonLaborCost":{ "type":"number", "description":"The actual cost for all nonlabor resources assigned to the activity as stored in the associated project baseline. This field is in base currency and is calculated from actualNonLaborCostProject field based on the specified exchange rate.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "actualLaborCostProject":{ "type":"number", "description":"The actual cost for all labor resources assigned to the activity as stored in the associated project baseline. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "actualTotalCostProject":{ "type":"number", "description":"The actual total cost for all labor, nonlabor, and material resources assigned to the activity as stored in the associated project baseline. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedLaborCostProject":{ "type":"number", "description":"The planned cost for all labor resources assigned to the activity in the associated project baseline. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedTotalCostProject":{ "type":"number", "description":"The expected total cost of the activity and includes all resources and direct activity costs (expenses) in the associated project baseline. This value is based on the project currency.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "plannedStart":{ "type":"string", "description":"The date the activity is scheduled to start.
              This date the activity is scheduled to begin is calculated by the project scheduler but can be updated manually by the project manager. This date cannot be changed by the project scheduler after the activity has started.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The date the activity is scheduled to finish if the activity has not started.
              This date is calculated by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has started.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The date work on the activity began.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The date when the activity was completed.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "startDateVariance":{ "type":"number", "description":"The duration between the current project start date and the baseline start date.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "finishDateVariance":{ "type":"number", "description":"The duration between the current project finish date and the baseline project finish date.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "startDate":{ "type":"string", "description":"The current start date of the activity.
              For started activities, this is the actual start date. For not started activities, this is the planned start date until the project is scheduled. When scheduled, the start date field is set to the remaining early start date.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The current finish date for the activity.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The total working time from the activity remaining start date to the remaining finish date.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "activityType":{ "type":"string", "description":"The type of activity. Valid values are Activity Dependent, Resource Dependent, Level of Effort, Start Milestone, and Finish Milestone.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "RESOURCE_DEPENDENT", "LEVEL_OF_EFFORT", "START_MILESTONE", "FINISH_MILESTONE", "WBS_SUMMARY" ] }, "actualDuration":{ "type":"number", "description":"The total working time from the activity Actual Start date to the Actual Finish date for completed activities, or the total working time from the Actual Start date to the data date for in-progress activities.
              The actual working time is computed using the activity's calendar.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "freeFloat":{ "type":"number", "description":"The amount of time the activity can be delayed before delaying the start date of any successor activity.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "secondaryConstraintDate":{ "type":"string", "description":"The date for the activity's secondary constraint, if the activity has a secondary constraint.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintType":{ "type":"string", "description":"The secondary restriction impacting the activity start or finish date.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "totalFloat":{ "type":"number", "description":"The amount of time the activity can be delayed before delaying the project finish date. Calculated as Late Start minus Early Start or as Late Finish minus Early Finish.", "format":"double", "readOnly":true, "exampleSetFlag":false }, "status":{ "type":"string", "description":"Determines the status of the activity. Valid values are Not Started, In Progress, and Completed.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] } }, "exampleSetFlag":false }, "ApiEntityActivityConfiguredFieldValue":{ "title":"ApiEntityActivityConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "activityConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Activity Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityId":{ "type":"integer", "description":"The system-generated identifier of a Activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityActivityFinancial":{ "title":"ApiEntityActivityFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "materialCostPercentComplete":{ "type":"number", "description":"The percent complete of costs for all material resource assigned to the activity.", "format":"double", "exampleSetFlag":false }, "expenseCostPercentComplete":{ "type":"number", "description":"The percent complete of cost for all expenses associated with the activity.", "format":"double", "exampleSetFlag":false }, "nonLaborCostPercentComplete":{ "type":"number", "description":"The percent complete of costs for all nonlabor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "estimateAtCompletionCost":{ "type":"number", "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateAtCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionMaterialCost":{ "type":"number", "description":"The sum of the actual and remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from atCompletionMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "estimateToCompletionCost":{ "type":"number", "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateToCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "laborCostPercentComplete":{ "type":"number", "description":"The percent complete of costs for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "atCompletionNonLaborCost":{ "type":"number", "description":"The sum of the actual and remaining costs for all non-labor resource assigned to the activity. This field is in base currency and is calculated from atCompletionNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualNonLaborCostProject":{ "type":"number", "description":"The actual costs for all nonlabor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualMaterialCostProject":{ "type":"number", "description":"The actual cost for all material resources assigned to the activity. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "actualThisPeriodLaborCost":{ "type":"number", "description":"The labor costs incurred during a financial period. This field is in base currency and is calculated from actualThisPeriodLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodLaborCostProject":{ "type":"number", "description":"The aggregation of all labor costs incurred during the current financial period. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodNonLaborCost":{ "type":"number", "description":"The nonlabor costs incurred during a financial period. This field is in base currency and is calculated from actualThisPeriodNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodNonLaborCostProject":{ "type":"number", "description":"The aggregation of all nonlabor costs incurred during the current financial period. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodMaterialCost":{ "type":"number", "description":"The material costs incurred during a financial period. This field is in base currency and is calculated from actualThisPeriodMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodMaterialCostProject":{ "type":"number", "description":"The aggregation of all material costs incurred during the current financial period. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodTotalCost":{ "type":"number", "description":"The aggregation of all labor, nonlabor, material and direct activity costs (expenses) incurred during this financial period. This field is in base currency and is calculated from actualThisPeriodTotalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodTotalCostProject":{ "type":"number", "description":"The aggregation of all labor, nonlabor, material and direct activity costs (expenses) incurred during this financial period. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionLaborCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all labor resource assignments on the activity. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "atCompletionNonLaborCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all nonlabor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionMaterialCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all material resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionTotalCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedNonLaborCostProject":{ "type":"number", "description":"The planned cost for all nonlabor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedMaterialCostProject":{ "type":"number", "description":"The planned cost for all material resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingLaborCostProject":{ "type":"number", "description":"The remaining cost for all labor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborCostProject":{ "type":"number", "description":"The remaining cost for all nonlabor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingMaterialCostProject":{ "type":"number", "description":"The remaining cost for all material resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingTotalCostProject":{ "type":"number", "description":"The remaining cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "estimateToCompletionCostProject":{ "type":"number", "description":"The estimated cost to complete the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "budgetAtCompletionProject":{ "type":"number", "description":"The budgeted or planned total cost through activity completion.
              Calculated as Planned Labor Cost plus Planned Non-labor Cost plus Planned Material Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "estimateAtCompletionCostProject":{ "type":"number", "description":"The forecasted cost of the project as the project progresses. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionVarianceProject":{ "type":"number", "description":"The difference between the baseline total cost and the current estimate of total cost. A negative value indicates an estimated cost overrun.
              Calculated as Budget At Completion minus Estimate At Completion. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "priorActualLaborCostProject":{ "type":"number", "description":"The sum of the actual stored period labor costs on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "priorActualTotalCostProject":{ "type":"number", "description":"The aggregated total of all labor, non-labor and material costs on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "priorActualMaterialCostProject":{ "type":"number", "description":"The sum of the actual stored period material costs on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "priorActualNonLaborCostProject":{ "type":"number", "description":"The sum of the actual stored period non-labor costs on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "blplannedExpenseCost":{ "type":"number", "description":"The planned cost for all project expenses associated with the activity.", "format":"double", "exampleSetFlag":false }, "atCompletionVariance":{ "type":"number", "description":"The difference between the baseline total cost and the current estimate of total cost. A negative value indicates an estimated cost overrun.
              Calculated as Budget At Completion minus Estimate At Completion. This field is in base currency and is calculated from atCompletionVarianceProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedValueCostProject":{ "type":"number", "description":"The approved budget for work actually completed by the specified project data date.
              Calculated as Budget At Completion multiplied by Performance Percent Complete. The method for computing performance percent complete depends on the Earned Value technique defined in the project settings. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostProject":{ "type":"number", "description":"The approved budget for the work scheduled to be completed by a specified date.
              Calculated as Budget At Completion multiplied by Schedule Percent Complete.
              When an activity has assignments, the Planned Value Cost is calculated as Budget At Completion multiplied by (Data Date of Current Project - Baseline Assignment Start Date) divided by (Baseline Assignment Finish Date - Baseline Assignment Start Date). Each assignment is then summed to the activity-level planned value. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceProject":{ "type":"number", "description":"A measure of activity schedule performance. The difference between the amount budgeted for the work you actually did and the work you planned to do.
              Indicates how much you are ahead or behind schedule. A negative value indicates that less work was actually performed than was scheduled.
              Calculated as Earned Value minus Planned Value. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "varCostProject":{ "type":"number", "description":"A measure of activity cost performance. The difference between the budgeted cost of work performed minus the actual cost of work performed.
              Indicates how much you are under or over your approved budget. A negative value indicates that the actual cost has exceeded the planned value.
              Calculated as Earned Value minus Actual Total Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "priorActualLaborCost":{ "type":"number", "description":"The sum of the actual stored period labor costs on the activity. This field is in base currency and is calculated from priorActualLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "priorActualTotalCost":{ "type":"number", "description":"The aggregated total of all labor, non-labor and material costs on the activity. This field is in base currency and is calculated from priorActualTotalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "priorActualMaterialCost":{ "type":"number", "description":"The sum of the actual stored period material costs on the activity. This field is in base currency and is calculated from priorActualMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "priorActualNonLaborCost":{ "type":"number", "description":"The sum of the actual stored period non-labor costs on the activity. This field is in base currency and is calculated from priorActualNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborCost":{ "type":"number", "description":"The remaining costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from remainingNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedNonLaborCost":{ "type":"number", "description":"The planned costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from plannedNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedValueCost":{ "type":"number", "description":"The portion of the baseline total cost of the activity that is scheduled to be completed as of the project data date. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedValueCost":{ "type":"number", "description":"The portion of the baseline total cost of the activity that is actually completed as of the project data date. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionLaborCost":{ "type":"number", "description":"The sum of the actual and remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from atCompletionLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingLaborCost":{ "type":"number", "description":"The remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from remainingLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "totalCostVariance":{ "type":"number", "description":"The difference between a project's baseline total cost and the at completion total cost.", "format":"double", "exampleSetFlag":false }, "actualTotalCost":{ "type":"number", "description":"The actual total cost for all resource assignments and direct activity costs (expenses) on the activity.", "format":"double", "exampleSetFlag":false }, "remainingMaterialCost":{ "type":"number", "description":"The remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from remainingMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedLaborCost":{ "type":"number", "description":"The planned costs for all labor resources assigned to the activity. This field is in base currency and is calculated from plannedLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "budgetAtCompletion":{ "type":"number", "description":"The planned total cost through activity completion. This field is in base currency and is calculated from budgetAtCompletionProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "materialCostVariance":{ "type":"number", "description":"The difference between the baseline planned material cost and the at completion material cost.", "format":"double", "exampleSetFlag":false }, "remainingTotalCost":{ "type":"number", "description":"The remaining cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingTotalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionTotalCost":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from atCompletionTotalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedMaterialCost":{ "type":"number", "description":"The planned costs for all material resources assigned to the activity. This field is in base currency and is calculated from plannedMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "nonLaborCostVariance":{ "type":"number", "description":"The difference between the baseline planned nonlabor cost and the at completion nonlabor cost.", "format":"double", "exampleSetFlag":false }, "actualLaborCost":{ "type":"number", "description":"The actual costs for all labor resources assigned to the activity. This field is in base currency and is calculated from actualLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualMaterialCost":{ "type":"number", "description":"The actual cost for all material resources assigned to the activity. This field is in base currency and is calculated from actualMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedTotalCost":{ "type":"number", "description":"The expected total cost of the activity and includes all resources and direct activity costs (expenses). This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "laborCostVariance":{ "type":"number", "description":"The difference between the baseline labor cost and the at completion labor cost.", "format":"double", "exampleSetFlag":false }, "actualNonLaborCost":{ "type":"number", "description":"The actual costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from actualNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualLaborCostProject":{ "type":"number", "description":"The actual costs for all labor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualTotalCostProject":{ "type":"number", "description":"The actual total cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "plannedLaborCostProject":{ "type":"number", "description":"The planned cost for all labor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedTotalCostProject":{ "type":"number", "description":"The expected total cost of the activity, including all resource assignments and direct activity costs. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "scheduleVariance":{ "type":"number", "description":"The measure of schedule performance on a project. This field is in base currency and is calculated from scheduleVarianceProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "activityId":{ "type":"integer", "description":"The unique identifier of the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "project":{ "type":"integer", "description":"The system-generated identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "varCost":{ "type":"number", "description":"The measure of cost performance on an activity. This field is in base currency and is calculated from varCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityActivityUncertainty":{ "title":"ApiEntityActivityUncertainty", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "maximumRemainingDuration":{ "type":"number", "description":"The estimated maximum amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.", "format":"double", "exampleSetFlag":false }, "minimumRemainingDuration":{ "type":"number", "description":"The estimated least amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.", "format":"double", "exampleSetFlag":false }, "mostLikelyRemainingDuration":{ "type":"number", "description":"The estimated most likely amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.", "format":"double", "exampleSetFlag":false }, "activityUncertaintyId":{ "type":"integer", "description":"The unique identifier of an uncertainty object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activity":{ "type":"integer", "description":"The ID of the activity that the uncertainty object is linked to.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "existenceProbability":{ "type":"number", "description":"Signifies the probability that a particular activity occurs (exists) in a given project. For example, an activity that may or may not have to be done depending on circumstances.", "format":"double", "exampleSetFlag":false }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "distributionShape":{ "type":"string", "description":"The probability distribution that best models the three-point estimate durations.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "project":{ "type":"integer", "description":"The ID of the project that the activity is in.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueActivity":{ "title":"ApiEntityCodeValueActivity", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueActivityId":{ "type":"integer", "description":"The unique identifier of an activity code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityActivityConfiguredFieldValueInput":{ "title":"ApiEntityActivityConfiguredFieldValueInput", "type":"object", "properties":{ "activityConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Activity Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ActivityConfiguredFieldValue object, a unique ActivityConfiguredFieldValue object can be identified by the following combinations of the fields.
              • activityConfiguredFieldValueId
              • columnDefinitionId
              • columnLabel
              • columnName
                • ", "exampleSetFlag":false }, "ApiEntityActivityFinancialInput":{ "title":"ApiEntityActivityFinancialInput", "type":"object", "properties":{ "materialCostPercentComplete":{ "type":"number", "description":"The percent complete of costs for all material resource assigned to the activity.", "format":"double", "exampleSetFlag":false }, "expenseCostPercentComplete":{ "type":"number", "description":"The percent complete of cost for all expenses associated with the activity.", "format":"double", "exampleSetFlag":false }, "nonLaborCostPercentComplete":{ "type":"number", "description":"The percent complete of costs for all nonlabor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "atCompletionMaterialCost":{ "type":"number", "description":"The sum of the actual and remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from atCompletionMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "laborCostPercentComplete":{ "type":"number", "description":"The percent complete of costs for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "atCompletionNonLaborCost":{ "type":"number", "description":"The sum of the actual and remaining costs for all non-labor resource assigned to the activity. This field is in base currency and is calculated from atCompletionNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualNonLaborCostProject":{ "type":"number", "description":"The actual costs for all nonlabor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualMaterialCostProject":{ "type":"number", "description":"The actual cost for all material resources assigned to the activity. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "actualThisPeriodLaborCost":{ "type":"number", "description":"The labor costs incurred during a financial period. This field is in base currency and is calculated from actualThisPeriodLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodLaborCostProject":{ "type":"number", "description":"The aggregation of all labor costs incurred during the current financial period. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodNonLaborCost":{ "type":"number", "description":"The nonlabor costs incurred during a financial period. This field is in base currency and is calculated from actualThisPeriodNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodNonLaborCostProject":{ "type":"number", "description":"The aggregation of all nonlabor costs incurred during the current financial period. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodMaterialCost":{ "type":"number", "description":"The material costs incurred during a financial period. This field is in base currency and is calculated from actualThisPeriodMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodMaterialCostProject":{ "type":"number", "description":"The aggregation of all material costs incurred during the current financial period. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionLaborCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all labor resource assignments on the activity. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "atCompletionNonLaborCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all nonlabor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionMaterialCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all material resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedNonLaborCostProject":{ "type":"number", "description":"The planned cost for all nonlabor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedMaterialCostProject":{ "type":"number", "description":"The planned cost for all material resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingLaborCostProject":{ "type":"number", "description":"The remaining cost for all labor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborCostProject":{ "type":"number", "description":"The remaining cost for all nonlabor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingMaterialCostProject":{ "type":"number", "description":"The remaining cost for all material resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "blplannedExpenseCost":{ "type":"number", "description":"The planned cost for all project expenses associated with the activity.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborCost":{ "type":"number", "description":"The remaining costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from remainingNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedNonLaborCost":{ "type":"number", "description":"The planned costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from plannedNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionLaborCost":{ "type":"number", "description":"The sum of the actual and remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from atCompletionLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingLaborCost":{ "type":"number", "description":"The remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from remainingLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingMaterialCost":{ "type":"number", "description":"The remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from remainingMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedLaborCost":{ "type":"number", "description":"The planned costs for all labor resources assigned to the activity. This field is in base currency and is calculated from plannedLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedMaterialCost":{ "type":"number", "description":"The planned costs for all material resources assigned to the activity. This field is in base currency and is calculated from plannedMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualLaborCost":{ "type":"number", "description":"The actual costs for all labor resources assigned to the activity. This field is in base currency and is calculated from actualLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualMaterialCost":{ "type":"number", "description":"The actual cost for all material resources assigned to the activity. This field is in base currency and is calculated from actualMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualNonLaborCost":{ "type":"number", "description":"The actual costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from actualNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualLaborCostProject":{ "type":"number", "description":"The actual costs for all labor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedLaborCostProject":{ "type":"number", "description":"The planned cost for all labor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "activityId":{ "type":"integer", "description":"The unique identifier of the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityActivityInput":{ "title":"ApiEntityActivityInput", "required":[ "projectId" ], "type":"object", "properties":{ "owner":{ "maxLength":255, "type":"string", "description":"The user responsible for the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "calendar":{ "type":"integer", "description":"The calendar assigned to the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "atCompletionNonLaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all nonlabor resources assigned to the activity.
                It is the same as the planned nonlabor units if the activity is not started, and the actual nonlabor units after the activity is completed.
                Calculated as Actual Nonlabor Units plus Remaining Nonlabor Units.", "format":"double", "exampleSetFlag":false }, "percentCompleteWeightedBy":{ "type":"string", "description":"The method used to calculate the scope percentage completion for scope assignments. The weight is calculated using cost, quantity, hours, or manually entered values.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COST", "QUANTITY", "HOURS", "MANUAL" ] }, "actualThisPeriodLaborUnits":{ "type":"number", "description":"The number of labor units used during this financial period.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodNonLaborUnits":{ "type":"number", "description":"The nonlabor units used during this financial period.", "format":"double", "exampleSetFlag":false }, "accountingVarianceLaborUnits":{ "type":"number", "description":"The difference between the planned value of work scheduled and the actual work performed.", "format":"double", "exampleSetFlag":false }, "activityFinancial":{ "description":"An object containing the financial fields of an activity in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityFinancialInput" } ] }, "activityUncertainties":{ "type":"array", "description":"The uncertainties associated with an activity.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityUncertaintyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "lateStart":{ "type":"string", "description":"The latest possible date the remaining work for the activity can begin without delaying the project finish date.
                This date is calculated based on activity relationships, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lateFinish":{ "type":"string", "description":"The latest possible date the activity can finish without delaying the project finish date.
                This date is calculated based on activity relationships, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyStart":{ "type":"string", "description":"The earliest possible date the remaining work for the activity can begin.
                This date is calculated based on network logic, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyFinish":{ "type":"string", "description":"The earliest possible date the activity can finish.
                This date is calculated based on network logic, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinish":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to finish.
                If this activity is not started, this date is the planned finish. This date can be updated manually by the user, but it is overwritten when you schedule the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStart":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to begin.
                This date can be updated manually by the user. Before the activity is started, this date is the same as the planned start.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "expectedFinish":{ "type":"string", "description":"The date you expect work on the activity to finish.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStart":{ "type":"string", "description":"The latest possible date the remaining work for the activity must begin without delaying the project finish date.
                This date is calculated by the project scheduler based on activity relationship, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinish":{ "type":"string", "description":"The latest possible date the activity must finish without delaying the project finish date.
                This date is calculated by the project scheduler based on activity relationships, schedule constraints, and resource availability. When the activity is complete, this field is blank.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "floatPath":{ "type":"integer", "description":"Indicates which critical path the activity is on. An activity with a floatPath value of 1 is on the most critical path, whereas an activity with a floatPath value of 2 is on the second most critical path, and so on.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValuesActivity":{ "type":"array", "description":"The list of code values for an activity. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueActivityInput", "exampleSetFlag":false }, "types":[ "array" ] }, "wbscodes":{ "type":"array", "description":"List of WBS codes in hierarchy.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "constraintDate":{ "type":"string", "description":"The constraint date for the activity, if the activity has a constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "activityPercentComplete":{ "type":"number", "description":"The percentage of the activity that has been completed.
                This value is based on the formula for the selected Percent Complete Type. The Percent Complete Type can be Physical, Duration, Units, or Scope.
                Physical: The user records the percent complete manually.
                Duration: Calculated as (Planned Duration minus Remaining Duration) divided by Planned Duration, multiplied by 100.
                Units: Calculated as (Actual Labor Units plus Actual Nonlabor Units) divided by (Actual Labor Units plus Actual Nonlabor Units plus Remaining Labor Units plus Remaining Nonlabor Units), multiplied by 100.
                Scope: Calculated as Installed Quantity divided by At Completion Quantity, multiplied by 100.", "format":"double", "exampleSetFlag":false }, "constraintType":{ "type":"string", "description":"The main restriction impacting the activity start or finish date.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "plannedDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The expected amount of time required to complete an activity.
                The planned working time is calculated using the activity's calendar. The duration is measured from the activity's planned start date to its planned finish date.", "format":"double", "exampleSetFlag":false }, "targetFinishDate":{ "type":"string", "description":"The Target Finish date for the activity used in Risk Analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageId":{ "type":"integer", "description":"The unique identifier for the work package that the activity is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "durationType":{ "type":"string", "description":"Determines how remaining duration, units, and units/time are calculated when you update an activity that has resources assigned. The valid values are Fixed Units/Time, Fixed Units, Fixed Duration & Units, and Fixed Duration & Units/Time.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FIXED_RATE", "FIXED_QUANTITY", "FIXED_DURATION_AND_UNITS", "FIXED_DURATION" ] }, "percentCompleteType":{ "type":"string", "description":"Determines the way in which the application calculates the percent complete for the activity.
                Physical: Percent complete is manually entered by a user based on the amount of physical work completed on the activity.
                Duration: Percent complete is calculated from the actual and remaining duration.
                Units: Percent complete is calculated from the actual and remaining units.
                Scope: The percent complete for the activity is derived from the scope percent complete of the linked scope assignments.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PHYSICAL", "DURATION", "UNITS", "SCOPE" ] }, "atCompletionLaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all labor resources assigned to the activity.
                It is the same as the planned labor units if the activity is not started, and the actual labor units after the activity is completed.
                Calculated as Actual Labor Units plus Remaining Labor Units.", "format":"double", "exampleSetFlag":false }, "activityPriority":{ "type":"string", "description":"Determines the priority of the activity when performing role leveling.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TOP", "HIGH", "NORMAL", "LOW", "LOWEST" ] }, "physicalPercentComplete":{ "type":"number", "description":"The activity percent complete, manually entered by a user.", "format":"double", "exampleSetFlag":false }, "plannedLaborUnits":{ "type":"number", "description":"The planned number of units for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "plannedNonLaborUnits":{ "type":"number", "description":"The planned units for all nonlabor resources assigned to the activities in the project.", "format":"double", "exampleSetFlag":false }, "remainingLaborUnits":{ "type":"number", "description":"The remaining units for all labor resources assigned to the activity.
                The Remaining Labor Units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborUnits":{ "type":"number", "description":"The remaining units for all nonlabor resources assigned to the activity.
                The remaining units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, there are zero remaining units.", "format":"double", "exampleSetFlag":false }, "actualLaborUnits":{ "type":"number", "description":"The number of units expended for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "actualNonLaborUnits":{ "type":"number", "description":"The number of nonlabor units that have been expended on the activity.", "format":"double", "exampleSetFlag":false }, "floatPathOrder":{ "type":"integer", "description":"The position of the activity on its critical path.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programMilestone":{ "type":"boolean", "description":"Display Milestone on Program.", "exampleSetFlag":false, "types":[ "boolean" ] }, "plannedStart":{ "type":"string", "description":"The date the activity is scheduled to start.
                This date the activity is scheduled to begin is calculated by the project scheduler but can be updated manually by the project manager. This date cannot be changed by the project scheduler after the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The date the activity is scheduled to finish if the activity has not started.
                This date is calculated by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The date work on the activity began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The date when the activity was completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the activity relative to others within the view.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityStatus":{ "type":"string", "description":"Determines the status of the activity. Valid values are Not Started, In Progress, and Completed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "startDate":{ "type":"string", "description":"The current start date of the activity.
                For started activities, this is the actual start date. For not started activities, this is the planned start date until the project is scheduled. When scheduled, the start date field is set to the remaining early start date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The current finish date for the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The total working time from the activity remaining start date to the remaining finish date.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "activityName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "activityType":{ "type":"string", "description":"The type of activity. Valid values are Activity Dependent, Resource Dependent, Level of Effort, Start Milestone, and Finish Milestone.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "RESOURCE_DEPENDENT", "LEVEL_OF_EFFORT", "START_MILESTONE", "FINISH_MILESTONE", "WBS_SUMMARY" ] }, "atCompletionDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The total working time from the activity's current start date to the current finish date.
                The current start date is the planned start date until the activity is started, and then it is the actual start date. The current finish date is the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. The total working time is calculated using the activity's calendar.", "format":"double", "exampleSetFlag":false }, "resumeDate":{ "type":"string", "description":"The date when a suspended task or activity is resumed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintDate":{ "type":"string", "description":"The date for the activity's secondary constraint, if the activity has a secondary constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintType":{ "type":"string", "description":"The secondary restriction impacting the activity start or finish date.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "suspendDate":{ "type":"string", "description":"The date work has temporarily stopped on a given activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for an activity.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"The WBS that the activity is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a Activity object, a unique Activity object can be identified by the following combinations of the fields.
                • activityId
                • activityCode,projectId
                • activityCode,projectCode,workspaceCode
                  • ", "exampleSetFlag":false }, "ApiEntityActivityUncertaintyInput":{ "title":"ApiEntityActivityUncertaintyInput", "type":"object", "properties":{ "maximumRemainingDuration":{ "type":"number", "description":"The estimated maximum amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.", "format":"double", "exampleSetFlag":false }, "minimumRemainingDuration":{ "type":"number", "description":"The estimated least amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.", "format":"double", "exampleSetFlag":false }, "mostLikelyRemainingDuration":{ "type":"number", "description":"The estimated most likely amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.", "format":"double", "exampleSetFlag":false }, "activityUncertaintyId":{ "type":"integer", "description":"The unique identifier of an uncertainty object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "existenceProbability":{ "type":"number", "description":"Signifies the probability that a particular activity occurs (exists) in a given project. For example, an activity that may or may not have to be done depending on circumstances.", "format":"double", "exampleSetFlag":false }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
                  • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                  • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                  ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "distributionShape":{ "type":"string", "description":"The probability distribution that best models the three-point estimate durations.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "project":{ "type":"integer", "description":"The ID of the project that the activity is in.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ActivityUncertainty object, a unique ActivityUncertainty object can be identified by the following combinations of the fields.
                  • activityUncertaintyId
                    • ", "exampleSetFlag":false }, "ApiEntityCodeValueActivityInput":{ "title":"ApiEntityCodeValueActivityInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueActivityId":{ "type":"integer", "description":"The unique identifier of an activity code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueActivity object, a unique CodeValueActivity object can be identified by the following combinations of the fields.
                    • codeValueActivityId
                    • codeValueId
                    • codeTypeId,codeValueCode
                    • codeTypeCode,codeValueCode
                    • codeTypeCode,parentId,codeValueCode
                    • codeValueCode,codeTypeId,parentId
                    • codeTypeCode,codeValueCode,projectCode
                    • codeTypeCode,codeValueCode,projectId
                    • codeTypeCode,codeValueCode,parentId,projectCode
                    • codeTypeCode,codeValueCode,parentId,projectId
                      • ", "exampleSetFlag":false }, "ApiEntityNotebookTopicActivity":{ "title":"ApiEntityNotebookTopicActivity", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityNotesId":{ "type":"integer", "description":"The unique identifier for the notebook topic and its activity association.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "notes":{ "type":"string", "description":"The notes for the notebook topic in HTML format.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityUserBaseline":{ "title":"ApiEntityUserBaseline", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"Identifies the official and unofficial baselines.
                      Original: A copy of the original project schedule, against which you can evaluate project progress. The original baseline locks down all original values. It marks the starting point for requiring change requests for modifications to Scope Items, Work Packages, and Scope Assignments.
                      Current: A copy of the latest project schedule. It can only be set when there is an original baseline. This is also referred to as the active baseline.
                      Other: A third official baseline that can be used for any purpose.
                      Blank: A blank field indicates this is an unofficial baseline, which could become an official baseline if desired.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CURRENT", "OTHER", "NONE" ] }, "time":{ "type":"string", "description":"The time at which the snapshot was generated.", "format":"date-time", "exampleSetFlag":false }, "userBaselinetype":{ "type":"string", "description":"The user's first, second, or third preference of user baselines.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "USER_BASELINE_1", "USER_BASELINE_2", "USER_BASELINE_3" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The username a user uses to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBaselineId":{ "type":"integer", "description":"The system-generated identifier of a baseline.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the baseline process. Valid values are: In Progress, Failed, and Complete.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IN_PROGRESS", "FAILED", "COMPLETE" ] }, "userId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "overlayId":{ "type":"integer", "description":"The system-generated identifier of a baseline.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dataDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false }, "baselineCategoryId":{ "type":"integer", "description":"The system-generated unique identifier of a baseline category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the baseline category.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBaselineActivity":{ "title":"ApiEntityBaselineActivity", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "activityFinancial":{ "description":"An object containing the financial fields of an activity in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityFinancial" } ] }, "codeValuesActivity":{ "type":"array", "description":"The list of code values for an activity. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "activityUncertainties":{ "type":"array", "description":"The uncertainties associated with an activity.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityUncertainty", "exampleSetFlag":false }, "types":[ "array" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for an activity.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "owner":{ "maxLength":255, "type":"string", "description":"The user responsible for the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "calendar":{ "type":"integer", "description":"The calendar assigned to the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityWorkManagerTaskDateStatus":{ "type":"string", "description":"The current state of task dates assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NO_TASK_DATES", "ALL_WITHIN", "AT_LEAST_ONE_OUTSIDE" ] }, "activityWorkManagerTaskStatus":{ "type":"string", "description":"The current status of the task assigned to the activity. Valid values are New, Pending, Committed, and Completed.
                      This is a read-only field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NO_TASKS", "ACTIVITY_COMPLETE_TASKS_NOT", "TASKS_COMPLETE_ACTIVITY_NOT", "BOTH_COMPLETE", "BOTH_NOT_COMPLETE" ] }, "activityWorkManagerTaskStatusIndicator":{ "type":"boolean", "description":"Indicates whether any of the activity's assigned tasks have dates or completion statuses that requires attention.
                      This is a read-only field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "durationPercentOfPlanned":{ "type":"number", "description":"The actual duration percent of planned duration for the activity. Calculated as Actual Duration divided by Original BL Duration multiplied by 100.", "format":"double", "exampleSetFlag":false }, "nonLaborUnitsCompletePercent":{ "type":"number", "description":"The percent complete of units for all nonlabor resources for the activity. Calculated as Actual Nonlabor Units divided by At Completion Nonlabor Units multiplied by 100.", "format":"double", "exampleSetFlag":false }, "laborUnitsCompletePercent":{ "type":"number", "description":"The percent complete of units for all labor resources for the activity. Calculated as Actual Labor Units divided by At Completion Labor Units multiplied by 100.", "format":"double", "exampleSetFlag":false }, "schedulePerfIndexLaborUnits":{ "type":"number", "description":"The ratio of the earned value of labor units to the planned value of labor units.
                      Calculated as Earned Value Labor Units divided by Planned Value Labor Units.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scheduleVarIndexLaborUnits":{ "type":"number", "description":"The ratio of schedule variance labor units and the planned value labor units.
                      Calculated as Schedule Variance Labor Units divided by Planned Value Labor Units.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "atCompletionBudgetLaborUnits":{ "type":"number", "description":"The planned total labor units through activity completion.", "format":"double", "exampleSetFlag":false }, "atCompletionNonLaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all nonlabor resources assigned to the activity.
                      It is the same as the planned nonlabor units if the activity is not started, and the actual nonlabor units after the activity is completed.
                      Calculated as Actual Nonlabor Units plus Remaining Nonlabor Units.", "format":"double", "exampleSetFlag":false }, "percentCompleteWeightedBy":{ "type":"string", "description":"The method used to calculate the scope percentage completion for scope assignments. The weight is calculated using cost, quantity, hours, or manually entered values.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COST", "QUANTITY", "HOURS", "MANUAL" ] }, "actualThisPeriodLaborUnits":{ "type":"number", "description":"The number of labor units used during this financial period.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodNonLaborUnits":{ "type":"number", "description":"The nonlabor units used during this financial period.", "format":"double", "exampleSetFlag":false }, "performancePercentComplete":{ "type":"number", "description":"The percentage of the planned work that is currently complete.
                      Performance Percent Complete is used to calculate earned value and is equal to the activity percent complete.", "format":"double", "exampleSetFlag":false }, "accountingVarianceLaborUnits":{ "type":"number", "description":"The difference between the planned value of work scheduled and the actual work performed.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceLaborUnits":{ "type":"number", "description":"The difference between the earned value of work performed and the work scheduled to be performed.
                      Calculated as Earned Value Labor Units minus Planned Value Labor Units.", "format":"double", "exampleSetFlag":false }, "estimateToCompletionLaborUnits":{ "type":"number", "description":"The estimated number of labor units required to complete the activity.
                      Calculated as the Remaining Total Units for the activity.", "format":"double", "exampleSetFlag":false }, "varianceAtCompletionLaborUnits":{ "type":"number", "description":"The difference between the baseline planned total labor units and the estimate at completion labor units.
                      Calculated as Project Baseline Planned Total Labor Units minus Estimate At Completion Labor Units.", "format":"double", "exampleSetFlag":false }, "estimateAtCompletionLaborUnits":{ "type":"number", "description":"The estimated labor units at completion.
                      Calculated as Actual Labor Units plus Estimate To Complete Labor Units. Estimate To Complete Labor Units is calculated based off of the Earned Value setting.", "format":"double", "exampleSetFlag":false }, "workManagerTaskPlannedOutsideCount":{ "type":"integer", "description":"The number of planned tasks assigned to the activity whose Start or Finish dates fall outside of the activity's Start or Finish dates.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskPlannedCompleteCount":{ "type":"integer", "description":"The number of planned tasks assigned to the activity that are completed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskPlannedNotCompleteCount":{ "type":"integer", "description":"The number of planned tasks assigned to the activity that are not completed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskUnplannedCount":{ "type":"integer", "description":"The number of unplanned tasks assigned to the activity that are not completed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costVarianceLaborUnitsIndex":{ "type":"number", "description":"The ratio of the cost variance labor units and the earned value labor units for the activity.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "schedulePerformanceIndex":{ "type":"number", "description":"The measure of work accomplished as a percentage of the work scheduled on the activity.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "toCompletePerformanceIndex":{ "type":"number", "description":"A measure of the value of the activity work that is remaining.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "priorActualNonLaborUnits":{ "type":"number", "description":"Prior Actual Nonlabor Units", "format":"double", "exampleSetFlag":false }, "costPerformanceIndexLaborUnits":{ "type":"number", "description":"The measure of a activity's cost efficiency in labor units.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "primaryResource":{ "type":"integer", "description":"The user designated as the primary resource for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "lateStart":{ "type":"string", "description":"The latest possible date the remaining work for the activity can begin without delaying the project finish date.
                      This date is calculated based on activity relationships, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lateFinish":{ "type":"string", "description":"The latest possible date the activity can finish without delaying the project finish date.
                      This date is calculated based on activity relationships, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyStart":{ "type":"string", "description":"The earliest possible date the remaining work for the activity can begin.
                      This date is calculated based on network logic, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyFinish":{ "type":"string", "description":"The earliest possible date the activity can finish.
                      This date is calculated based on network logic, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinish":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to finish.
                      If this activity is not started, this date is the planned finish. This date can be updated manually by the user, but it is overwritten when you schedule the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStart":{ "type":"string", "description":"The date the remaining work for the activity is scheduled to begin.
                      This date can be updated manually by the user. Before the activity is started, this date is the same as the planned start.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "expectedFinish":{ "type":"string", "description":"The date you expect work on the activity to finish.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStart":{ "type":"string", "description":"The latest possible date the remaining work for the activity must begin without delaying the project finish date.
                      This date is calculated by the project scheduler based on activity relationship, schedule constraints, and resource availability.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinish":{ "type":"string", "description":"The latest possible date the activity must finish without delaying the project finish date.
                      This date is calculated by the project scheduler based on activity relationships, schedule constraints, and resource availability. When the activity is complete, this field is blank.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "floatPath":{ "type":"integer", "description":"Indicates which critical path the activity is on. An activity with a floatPath value of 1 is on the most critical path, whereas an activity with a floatPath value of 2 is on the second most critical path, and so on.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbscodes":{ "type":"array", "description":"List of WBS codes in hierarchy.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "resourceCodeList":{ "maxLength":930, "minLength":0, "type":"string", "description":"The unique identifiers of the resources assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceNameList":{ "maxLength":3855, "minLength":0, "type":"string", "description":"The names of the resources assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "roleCodeList":{ "maxLength":930, "minLength":0, "type":"string", "description":"The unique identifiers of the roles assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "roleNameList":{ "maxLength":3855, "minLength":0, "type":"string", "description":"The names of the roles assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "danglingFinish":{ "type":"boolean", "description":"An activity with a dangling finish has only SF or SS successors and therefore could have an unrealistic finish date. To avoid dangling finishes, ensure each activity has at least one FS or SS relationship as its successor.", "exampleSetFlag":false, "types":[ "boolean" ] }, "danglingStart":{ "type":"boolean", "description":"An activity with a dangling start has only SF or FF predecessors and therefore could have an unrealistic start date. To avoid dangling starts, ensure each activity has at least one FS or SS relationship as its predecessor.", "exampleSetFlag":false, "types":[ "boolean" ] }, "ffPredecessor":{ "type":"boolean", "description":"Finish-to-Finish (FF) relationships are acceptable to use in moderation.", "exampleSetFlag":false, "types":[ "boolean" ] }, "fsPredecessor":{ "type":"boolean", "description":"Finish-to-Start (FS) relationships are the easiest to trace and understand. The majority of your relationships should be FS.", "exampleSetFlag":false, "types":[ "boolean" ] }, "hardConstraint":{ "type":"boolean", "description":"Mandatory Start and Mandatory Finish are hard constraints that prevent activities from being scheduled according to logic and prevent delays from impacting succeeding activities. The effects of hard constraints become more noticeable as the schedule is progressed, and they generally should not be used.", "exampleSetFlag":false, "types":[ "boolean" ] }, "invalidProgressDate":{ "type":"boolean", "description":"Progress should be recorded before the Data Date, and planned work should be recorded after. Activities with invalid dates can affect the accuracy of the project schedule.", "exampleSetFlag":false, "types":[ "boolean" ] }, "largeDuration":{ "type":"boolean", "description":"Large duration activities are harder to manage and may lack sufficient detail. Consider dividing these activities into shorter, more discrete activities, which provide better insight into cost and schedule.", "exampleSetFlag":false, "types":[ "boolean" ] }, "largeFloat":{ "type":"boolean", "description":"Large float values may indicate missing activity relationships. Provide activities with reasonable logic to ensure a more stable project plan.", "exampleSetFlag":false, "types":[ "boolean" ] }, "lateActivity":{ "type":"boolean", "description":"Late activities indicate how well the project is performing against the earned value baseline.", "exampleSetFlag":false, "types":[ "boolean" ] }, "negativeFloat":{ "type":"boolean", "description":"Negative float usually indicates an activity constraint that cannot be met with the current schedule or progress has been made out of sequence. Corrective action should be taken to ensure activity dates are accurate and achievable.", "exampleSetFlag":false, "types":[ "boolean" ] }, "noPredecessor":{ "type":"boolean", "description":"An activity with no predecessors could be scheduled to start immediately. This can negatively impact your project schedule and should be avoided.", "exampleSetFlag":false, "types":[ "boolean" ] }, "noResource":{ "type":"boolean", "description":"Roles and resources detail the cost and labor of the work to be performed. An activity without roles or resources may be insufficiently planned.", "exampleSetFlag":false, "types":[ "boolean" ] }, "noSuccessor":{ "type":"boolean", "description":"An activity with no successor relationships could be delayed indefinitely without affecting project completion. Ensure all activities have at least one successor.", "exampleSetFlag":false, "types":[ "boolean" ] }, "openEnds":{ "type":"boolean", "description":"An activity without a predecessor or successor relationship may negatively affect the quality of your schedule and should be avoided.", "exampleSetFlag":false, "types":[ "boolean" ] }, "predecessorLag":{ "type":"boolean", "description":"Lag time between activities should not be used to control float or constrain dates. Consider representing the delay between two activities by adding another activity.", "exampleSetFlag":false, "types":[ "boolean" ] }, "predecessorNegativeLag":{ "type":"boolean", "description":"The use of negative lags to overlap activities or adjust successor dates can affect the critical path and distort total float. It can also cause a successor to start before a predecessor. Negative lags can cause activities to be scheduled in unrealistic ways and generally should not be used.", "exampleSetFlag":false, "types":[ "boolean" ] }, "sfPredecessor":{ "type":"boolean", "description":"Start-to-Finish (SF) relationship logic says the successor occurs before the predecessor. SF relationships are a poor practice and generally should not be used.", "exampleSetFlag":false, "types":[ "boolean" ] }, "softConstraint":{ "type":"boolean", "description":"Soft constraints allow the schedule to be logic driven but can distort float and create negative float.", "exampleSetFlag":false, "types":[ "boolean" ] }, "ssPredecessor":{ "type":"boolean", "description":"Start-to-Start (SS) relationships are acceptable to use in moderation.", "exampleSetFlag":false, "types":[ "boolean" ] }, "constraintDate":{ "type":"string", "description":"The constraint date for the activity, if the activity has a constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "activityPercentComplete":{ "type":"number", "description":"The percentage of the activity that has been completed.
                      This value is based on the formula for the selected Percent Complete Type. The Percent Complete Type can be Physical, Duration, Units, or Scope.
                      Physical: The user records the percent complete manually.
                      Duration: Calculated as (Planned Duration minus Remaining Duration) divided by Planned Duration, multiplied by 100.
                      Units: Calculated as (Actual Labor Units plus Actual Nonlabor Units) divided by (Actual Labor Units plus Actual Nonlabor Units plus Remaining Labor Units plus Remaining Nonlabor Units), multiplied by 100.
                      Scope: Calculated as Installed Quantity divided by At Completion Quantity, multiplied by 100.", "format":"double", "exampleSetFlag":false }, "constraintType":{ "type":"string", "description":"The main restriction impacting the activity start or finish date.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "plannedDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The expected amount of time required to complete an activity.
                      The planned working time is calculated using the activity's calendar. The duration is measured from the activity's planned start date to its planned finish date.", "format":"double", "exampleSetFlag":false }, "targetFinishDate":{ "type":"string", "description":"The Target Finish date for the activity used in Risk Analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "critical":{ "type":"boolean", "description":"Designates an activity as critical. An activity is defined as critical based upon the project settings configured for the project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workPackageId":{ "type":"integer", "description":"The unique identifier for the work package that the activity is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "durationType":{ "type":"string", "description":"Determines how remaining duration, units, and units/time are calculated when you update an activity that has resources assigned. The valid values are Fixed Units/Time, Fixed Units, Fixed Duration & Units, and Fixed Duration & Units/Time.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FIXED_RATE", "FIXED_QUANTITY", "FIXED_DURATION_AND_UNITS", "FIXED_DURATION" ] }, "scopePercentComplete":{ "type":"number", "description":"The percentage completion of the scope assignments linked to the activity.
                      Calculated as Installed Quantity divided by At Completion Quantity.", "format":"double", "exampleSetFlag":false }, "percentCompleteType":{ "type":"string", "description":"Determines the way in which the application calculates the percent complete for the activity.
                      Physical: Percent complete is manually entered by a user based on the amount of physical work completed on the activity.
                      Duration: Percent complete is calculated from the actual and remaining duration.
                      Units: Percent complete is calculated from the actual and remaining units.
                      Scope: The percent complete for the activity is derived from the scope percent complete of the linked scope assignments.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PHYSICAL", "DURATION", "UNITS", "SCOPE" ] }, "atCompletionLaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all labor resources assigned to the activity.
                      It is the same as the planned labor units if the activity is not started, and the actual labor units after the activity is completed.
                      Calculated as Actual Labor Units plus Remaining Labor Units.", "format":"double", "exampleSetFlag":false }, "activityPriority":{ "type":"string", "description":"Determines the priority of the activity when performing role leveling.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TOP", "HIGH", "NORMAL", "LOW", "LOWEST" ] }, "physicalPercentComplete":{ "type":"number", "description":"The activity percent complete, manually entered by a user.", "format":"double", "exampleSetFlag":false }, "completedWeight":{ "type":"number", "description":"The weight of the activity percent completed value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "remainingFloat":{ "type":"number", "description":"The amount of time remaining in which the activity can be delayed before delaying the project finish date. Calculated as Late Finish minus Remaining Finish.", "format":"double", "exampleSetFlag":false }, "durationPercentComplete":{ "type":"number", "description":"The duration percent complete for the activity. Calculated as Planned Duration minus Remaining Duration divided by Planned Duration multiplied by 100.", "format":"double", "exampleSetFlag":false }, "recordCount":{ "type":"integer", "description":"The number of activities added to the project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedLaborUnits":{ "type":"number", "description":"The planned number of units for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "plannedNonLaborUnits":{ "type":"number", "description":"The planned units for all nonlabor resources assigned to the activities in the project.", "format":"double", "exampleSetFlag":false }, "remainingLaborUnits":{ "type":"number", "description":"The remaining units for all labor resources assigned to the activity.
                      The Remaining Labor Units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborUnits":{ "type":"number", "description":"The remaining units for all nonlabor resources assigned to the activity.
                      The remaining units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, there are zero remaining units.", "format":"double", "exampleSetFlag":false }, "schedulePercentComplete":{ "type":"number", "description":"The activity schedule percent complete specifies how much of the activity's project baseline duration is complete so far.
                      With an earned value baseline selected, the schedule percent complete value is calculated based on where the current data date falls relative to the activity's project baseline start and finish dates.
                      Calculated as (Data Date - Baseline Start Date) / (Baseline Finish Date - Baseline Start Date).
                      If the data date is earlier than the baseline start, the schedule percent complete is 0. If the data date is later than the baseline finish, the schedule percent complete is 100.
                      Without an earned value baseline selected, the schedule percent complete value will use the activity planned dates and will be calculated based on where the current data date falls relative each activity's planned start and finish dates.
                      Calculated as (Data Date - Planned Start Date) / (Planned Finish Date - Planned Start Date).
                      If the data date is earlier than the planned start, the schedule percent complete is 0. If the data date is later than the planned finish, the schedule percent complete is 100.", "format":"double", "exampleSetFlag":false }, "actualLaborUnits":{ "type":"number", "description":"The number of units expended for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "actualNonLaborUnits":{ "type":"number", "description":"The number of nonlabor units that have been expended on the activity.", "format":"double", "exampleSetFlag":false }, "unitsPercentComplete":{ "type":"number", "description":"The percent complete of units for all labor and nonlabor resources assigned to the activity. Calculated as Actual Units divided by At Completion Units multiplied by 100.", "format":"double", "exampleSetFlag":false }, "costVarianceLaborUnits":{ "type":"number", "description":"The difference between the earned value labor units and the actual labor units.", "format":"double", "exampleSetFlag":false }, "earnedValueLaborUnits":{ "type":"number", "description":"The portion of baseline labor units that are actually completed as of the project data date.
                      Calculated as Budget At Completion Labor Units multiplied by Performance Percent Complete. The performance percent complete will be calculated using the activity percent complete.", "format":"double", "exampleSetFlag":false }, "varLaborUnits":{ "type":"number", "description":"The difference between baseline labor units and at completion labor units.
                      ", "format":"double", "exampleSetFlag":false }, "varStartDate":{ "type":"number", "description":"The duration between the current project start date and the baseline start date.", "format":"double", "exampleSetFlag":false }, "varFinishDate":{ "type":"number", "description":"The duration between the current project finish date and the baseline project finish date.", "format":"double", "exampleSetFlag":false }, "varNonLaborUnits":{ "type":"number", "description":"The difference between the baseline nonlabor units and the at completion nonlabor units.", "format":"double", "exampleSetFlag":false }, "varDuration":{ "type":"number", "description":"The duration between the activity's duration and the at completion duration.", "format":"double", "exampleSetFlag":false }, "plannedValueLaborUnits":{ "type":"number", "description":"The portion of baseline labor units that are scheduled to be completed as of the project data date.
                      Calculated as Budget At Completion Labor Units multiplied by Schedule Percent Complete.", "format":"double", "exampleSetFlag":false }, "floatPathOrder":{ "type":"integer", "description":"The position of the activity on its critical path.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskCount":{ "type":"integer", "description":"The number of tasks assigned to an activity.
                      This is a read-only field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programMilestone":{ "type":"boolean", "description":"Display Milestone on Program.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costVarianceIndex":{ "type":"number", "description":"The ratio of the cost variance and the earned value of work performed on the WBS or activity.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scheduleVarianceIndex":{ "type":"number", "description":"The ratio of schedule variance and the work scheduled to be performed.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "priorActualLaborUnits":{ "type":"number", "description":"Prior Actual Labor Units", "format":"double", "exampleSetFlag":false }, "costPerformanceIndex":{ "type":"number", "description":"The measure of a activity's cost efficiency.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "plannedStart":{ "type":"string", "description":"The date the activity is scheduled to start.
                      This date the activity is scheduled to begin is calculated by the project scheduler but can be updated manually by the project manager. This date cannot be changed by the project scheduler after the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The date the activity is scheduled to finish if the activity has not started.
                      This date is calculated by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The date work on the activity began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The date when the activity was completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the activity relative to others within the view.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "activityStatus":{ "type":"string", "description":"Determines the status of the activity. Valid values are Not Started, In Progress, and Completed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "startDate":{ "type":"string", "description":"The current start date of the activity.
                      For started activities, this is the actual start date. For not started activities, this is the planned start date until the project is scheduled. When scheduled, the start date field is set to the remaining early start date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The current finish date for the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The total working time from the activity remaining start date to the remaining finish date.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "activityName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "activityType":{ "type":"string", "description":"The type of activity. Valid values are Activity Dependent, Resource Dependent, Level of Effort, Start Milestone, and Finish Milestone.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "RESOURCE_DEPENDENT", "LEVEL_OF_EFFORT", "START_MILESTONE", "FINISH_MILESTONE", "WBS_SUMMARY" ] }, "actualDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The total working time from the activity Actual Start date to the Actual Finish date for completed activities, or the total working time from the Actual Start date to the data date for in-progress activities.
                      The actual working time is computed using the activity's calendar.", "format":"double", "exampleSetFlag":false }, "atCompletionDuration":{ "maximum":10000000, "minimum":0, "type":"number", "description":"The total working time from the activity's current start date to the current finish date.
                      The current start date is the planned start date until the activity is started, and then it is the actual start date. The current finish date is the activity planned finish date while the activity is not started, the remaining finish date while the activity is in progress, and the actual finish date once the activity is completed. The total working time is calculated using the activity's calendar.", "format":"double", "exampleSetFlag":false }, "drivingPath":{ "type":"boolean", "description":"The sequence of project activities from start to finish where the Total Duration is longer than any other path.", "exampleSetFlag":false, "types":[ "boolean" ] }, "freeFloat":{ "type":"number", "description":"The amount of time the activity can be delayed before delaying the start date of any successor activity.", "format":"double", "exampleSetFlag":false }, "resumeDate":{ "type":"string", "description":"The date when a suspended task or activity is resumed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintDate":{ "type":"string", "description":"The date for the activity's secondary constraint, if the activity has a secondary constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintType":{ "type":"string", "description":"The secondary restriction impacting the activity start or finish date.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "suspendDate":{ "type":"string", "description":"The date work has temporarily stopped on a given activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "totalFloat":{ "type":"number", "description":"The amount of time the activity can be delayed before delaying the project finish date. Calculated as Late Start minus Early Start or as Late Finish minus Early Finish.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "outOfSequence":{ "type":"boolean", "description":"Activities that progress out of sequence occur when a successor activity begins or completes before its predecessor finishes. This can lead to inaccurate timelines and project risks. Identify and correct out of sequence activities to ensure that the project schedule is accurate.", "exampleSetFlag":false, "types":[ "boolean" ] }, "starred":{ "type":"boolean", "description":"Specifies whether the activity has been marked as important.", "exampleSetFlag":false, "types":[ "boolean" ] }, "wbsId":{ "type":"integer", "description":"The WBS that the activity is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "weight":{ "type":"number", "description":"The importance of the activity in relation to other activities.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ActivityIdentifier":{ "title":"ActivityIdentifier", "type":"object", "properties":{ "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ActivityRiskIdentifier":{ "title":"ActivityRiskIdentifier", "type":"object", "properties":{ "activityRiskId":{ "type":"integer", "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityId":{ "type":"integer", "description":"The unique identifier of an activity assigned to a risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntitySyncApiResponse":{ "title":"ApiEntitySyncApiResponse", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "identifier":{ "type":"object", "description":"The unique identifier of the supported object returned based on the user input.
                      This field can return any of the following entities determined based on the object for which the API call is invoked.
                      Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.", "exampleSetFlag":false, "oneOf":[ { "$ref":"#/components/schemas/ConstraintIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CBSSheetSegmentIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CBSTemplateSegmentIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ScopeAssignmentActualsTimePhasedDataIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ScopeAssignmentInstalledTimePhasedDataIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ResourceWorkRateIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ReasonIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/WorkManagerTaskIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ChangeRequestIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ScopeItemAssignmentActivityIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/RiskScoreTypeIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/RiskMatrixIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectRiskIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProgramRiskIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ActivityRiskIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/RiskMitigationIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProgramRiskMitigationIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProgramRiskWeatherPeriodIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/HolidayGroupIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/RiskWeatherPeriodIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/PortfolioIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/PortfolioMeasureIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/EntityReferenceIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/PortfolioMeasureManualValueIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CustomLogItemIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectRankIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectDependencyIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/LocationIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/MeasureIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/MeasureThresholdIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ReportCycleIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/UnitsOfMeasureIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/WorkspaceIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ApplicationUserGroupIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CalendarIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CodeTypeIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CodeValueIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CostCategoryIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CurveIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/DocumentFolderStructureTemplateIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/IdeaIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/OfficeIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectCompanyIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ResourceDemandIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectBudgetChangeIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectBudgetTransferIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectResourceWorkRateIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectActualsLineItemIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectActualsIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectBudgetItemIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProgramIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/StrategyIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/StrategyTypeIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/RuleOfCreditIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ResourceRoleAssignmentIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/BudgetPlanningScenarioIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ScopeAssignmentPlannedTimePhasedDataIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProgramBudgetTransferIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProgramBudgetChangeIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ActivityIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/AssignmentIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/RelationshipIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/FundActualIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProgramBudgetItemIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/NotebookTopicsIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ProjectCashflowIdentifier", "exampleSetFlag":false } ] }, "message":{ "type":"string", "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApplicationUserGroupIdentifier":{ "title":"ApplicationUserGroupIdentifier", "type":"object", "properties":{ "scopeId":{ "type":"integer", "description":"The unique identifier of a project/workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "applicationUserGroupId":{ "type":"integer", "description":"The unique identifier of a user group.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "groupName":{ "maxLength":255, "minLength":1, "type":"string", "description":"Name of a user group.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeCode":{ "type":"string", "description":"The unique identifier for a project/workspace set by the user who created the project/workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "scope":{ "type":"string", "description":"Type of a user group.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT", "WORKSPACE" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "AssignmentIdentifier":{ "title":"AssignmentIdentifier", "type":"object", "properties":{ "resourceClass":{ "type":"string", "description":"The class of the resource of an assignment. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "assignmentId":{ "type":"integer", "description":"The system-generated identifier of an assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "assignmentCode":{ "maxLength":60, "type":"string", "description":"A unique identifier for the assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "type":"string", "description":"The user-specified identifier of a resource.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "BudgetPlanningScenarioIdentifier":{ "title":"BudgetPlanningScenarioIdentifier", "type":"object", "properties":{ "portfolioName":{ "maxLength":255, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated identifier of the Budget Plan Scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "maxLength":255, "type":"string", "description":"The name of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "planPeriod":{ "type":"integer", "description":"The period during which budget is allocated to projects within the plan.
                      This value determines the year in which budget planning timescales start.
                      You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
                      After the planning period for a budget plan has been set it cannot be changed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "CBSSheetSegmentIdentifier":{ "title":"CBSSheetSegmentIdentifier", "required":[ "segmentDefinitionName" ], "type":"object", "properties":{ "cbsSheetSegmentId":{ "type":"integer", "description":"The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "segmentDefinitionName":{ "maxLength":255, "type":"string", "description":"The name of the level of the cost breakdown structure segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "CBSTemplateSegmentIdentifier":{ "title":"CBSTemplateSegmentIdentifier", "required":[ "segmentDefinitionName" ], "type":"object", "properties":{ "cbsTemplateSegmentId":{ "type":"integer", "description":"The unique identifier for the CBS segment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "segmentDefinitionName":{ "maxLength":255, "type":"string", "description":"The name of the CBS segment.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "CalendarIdentifier":{ "title":"CalendarIdentifier", "type":"object", "properties":{ "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarCode":{ "maxLength":255, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ChangeRequestIdentifier":{ "title":"ChangeRequestIdentifier", "type":"object", "properties":{ "changeRequestId":{ "type":"integer", "description":"The unique identifier of the change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "changeRequestCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier of the change request.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "CodeTypeIdentifier":{ "title":"CodeTypeIdentifier", "type":"object", "properties":{ "codeTypeId":{ "type":"integer", "description":"The system-generated identifier of a code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "type":"string", "description":"Displays the code or ID of the Code Type.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "CodeValueIdentifier":{ "title":"CodeValueIdentifier", "type":"object", "properties":{ "parentCVCodes":{ "type":"array", "description":"List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The system-generated identifier of a code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "type":"string", "description":"Displays the code or ID of the Code Type.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ConstraintIdentifier":{ "title":"ConstraintIdentifier", "required":[ "constraintCode" ], "type":"object", "properties":{ "constraintCode":{ "type":"string", "description":"The user specified identifier for a constraint.", "exampleSetFlag":false, "types":[ "string" ] }, "constraintId":{ "type":"integer", "description":"The unique identifier of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "CostCategoryIdentifier":{ "title":"CostCategoryIdentifier", "type":"object", "properties":{ "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "abbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviation for the cost category name.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of a cost category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "CurveIdentifier":{ "title":"CurveIdentifier", "type":"object", "properties":{ "curveName":{ "maxLength":255, "type":"string", "description":"The name of the curve profile.", "exampleSetFlag":false, "types":[ "string" ] }, "curveId":{ "type":"integer", "description":"The unique identifier of a curve.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "CustomLogItemIdentifier":{ "title":"CustomLogItemIdentifier", "type":"object", "properties":{ "customLogItemId":{ "type":"integer", "description":"The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogItemCode":{ "maxLength":60, "type":"string", "description":"A unique identifier unique of the custom log item.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeObjectName":{ "type":"string", "description":"The user-specified identifier of a custom log type.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "CustomLogTypeObjectIdentifier":{ "title":"CustomLogTypeObjectIdentifier", "type":"object", "properties":{ "scopeId":{ "type":"integer", "description":"The system-generated identifier of a reference to another object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogTypeObjectName":{ "type":"string", "description":"The user-defined identifier of a custom log type object.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeCode":{ "type":"string", "description":"The user-defined identifier of a reference to another object.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The system-generated identifier of custom log type object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "maxLength":40, "type":"string", "description":"The scope of an object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "project", "program", "workspace" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "DocumentFolderStructureTemplateIdentifier":{ "title":"DocumentFolderStructureTemplateIdentifier", "type":"object", "properties":{ "documentFolderStructureTemplateId":{ "type":"integer", "description":"The system-generated identifier of a document folder structure template.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "templateName":{ "maxLength":255, "type":"string", "description":"The name of the document template.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "EntityReferenceIdentifier":{ "title":"EntityReferenceIdentifier", "type":"object", "properties":{ "entityReferenceId":{ "type":"integer", "description":"The system-generated identifier of a reference.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "FundActualIdentifier":{ "title":"FundActualIdentifier", "type":"object", "properties":{ "projectActualsId":{ "type":"integer", "description":"The system-generated identifier of a project actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundActualId":{ "type":"integer", "description":"The system-generated identifier of a fund actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for an actual.", "exampleSetFlag":false, "types":[ "string" ] }, "fundCode":{ "type":"string", "description":"The user-specified unique identifier of a fund.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "fundId":{ "type":"integer", "description":"The system-generated identifier of a fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "HolidayGroupIdentifier":{ "title":"HolidayGroupIdentifier", "type":"object", "properties":{ "holidayGroupName":{ "maxLength":60, "type":"string", "description":"The name of the holiday list.", "exampleSetFlag":false, "types":[ "string" ] }, "holidayListId":{ "type":"integer", "description":"The unique identifier for the holiday list.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "IdeaIdentifier":{ "title":"IdeaIdentifier", "type":"object", "properties":{ "ideaName":{ "type":"string", "description":"The name of the Idea.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "LocationIdentifier":{ "title":"LocationIdentifier", "type":"object", "properties":{ "locationId":{ "type":"integer", "description":"The unique identifier for the location.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "locationCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of the location.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "MeasureIdentifier":{ "title":"MeasureIdentifier", "type":"object", "properties":{ "measureId":{ "type":"integer", "description":"The unique identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "MeasureThresholdIdentifier":{ "title":"MeasureThresholdIdentifier", "type":"object", "properties":{ "measureThresholdId":{ "type":"integer", "description":"The unique identifier of a threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "computeAgainstType":{ "type":"string", "description":"The against type of a threshold.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTUAL_VALUE", "PERCENT_OF_TARGET" ] }, "desirableState":{ "type":"string", "description":"The type of direction of a threshold.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HIGH_VALUES", "LOW_VALUES" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "NotebookTopicsIdentifier":{ "title":"NotebookTopicsIdentifier", "type":"object", "properties":{ "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "OfficeIdentifier":{ "title":"OfficeIdentifier", "type":"object", "properties":{ "officeId":{ "type":"integer", "description":"The unique identifier of an office.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "officeName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the office.", "exampleSetFlag":false, "types":[ "string" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postalCode":{ "maxLength":20, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "PortfolioMeasureIdentifier":{ "title":"PortfolioMeasureIdentifier", "type":"object", "properties":{ "portfolioMeasureId":{ "type":"integer", "description":"The unique identifier of a portfolio measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a portfolio measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "PortfolioMeasureManualValueIdentifier":{ "title":"PortfolioMeasureManualValueIdentifier", "type":"object", "properties":{ "portfolioMeasureManualValueId":{ "type":"integer", "description":"The unique identifier of a portfolio measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "beginDate":{ "type":"string", "description":"The start date of a portfolio.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a portfolio measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "endDate":{ "type":"string", "description":"The end date of the portfolio.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ProgramBudgetChangeIdentifier":{ "title":"ProgramBudgetChangeIdentifier", "type":"object", "properties":{ "programBudgetChangeCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the program budget change request.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a program budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProgramBudgetItemIdentifier":{ "title":"ProgramBudgetItemIdentifier", "type":"object", "properties":{ "programBudgetItemCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the program budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetItemId":{ "type":"integer", "description":"The system-generated identifier for a budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProgramBudgetTransferIdentifier":{ "title":"ProgramBudgetTransferIdentifier", "type":"object", "properties":{ "programBudgetTransferCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the program budget transfer request.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a program budget transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProgramRiskIdentifier":{ "title":"ProgramRiskIdentifier", "type":"object", "properties":{ "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProgramRiskMitigationIdentifier":{ "title":"ProgramRiskMitigationIdentifier", "type":"object", "properties":{ "programRiskMitigationCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ProgramRiskWeatherPeriodIdentifier":{ "title":"ProgramRiskWeatherPeriodIdentifier", "type":"object", "properties":{ "programRiskWeatherPeriodId":{ "type":"integer", "description":"The system-generated identifier for the period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodName":{ "maxLength":255, "type":"string", "description":"The name of the period.", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ProjectActualsIdentifier":{ "title":"ProjectActualsIdentifier", "type":"object", "properties":{ "projectActualsId":{ "type":"integer", "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsCode":{ "type":"string", "description":"The user-specified identifier of a project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ProjectActualsLineItemIdentifier":{ "title":"ProjectActualsLineItemIdentifier", "type":"object", "properties":{ "projectActualsLineItemId":{ "type":"integer", "description":"The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsLineItemCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier for an actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsCode":{ "type":"string", "description":"The user-specified identifier of a project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ProjectBudgetChangeIdentifier":{ "title":"ProjectBudgetChangeIdentifier", "type":"object", "properties":{ "budgetChangeCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the project budget change request.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ProjectBudgetItemIdentifier":{ "title":"ProjectBudgetItemIdentifier", "type":"object", "properties":{ "budgetItemCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the project budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier of a budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ProjectBudgetTransferIdentifier":{ "title":"ProjectBudgetTransferIdentifier", "type":"object", "properties":{ "budgetTransferCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the project budget transfer request.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a budget transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ProjectCashflowIdentifier":{ "title":"ProjectCashflowIdentifier", "type":"object", "properties":{ "year":{ "type":"integer", "description":"The time period during which budget planning for the project takes place in years.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "month":{ "type":"integer", "description":"The time period during which budget planning for the project takes place in months.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectPhaseFinancialId":{ "type":"integer", "description":"The unique internal identifier for the project's time-phased cost spread. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "spreadDate":{ "type":"string", "description":"The starting date for a time phase of the project life cycle.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProjectCompanyIdentifier":{ "title":"ProjectCompanyIdentifier", "type":"object", "properties":{ "projectCompanyId":{ "type":"integer", "description":"The system-generated unique identifier of the project company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postalCode":{ "maxLength":20, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ProjectDependencyIdentifier":{ "title":"ProjectDependencyIdentifier", "type":"object", "properties":{ "dependentProjectWorkspaceCode":{ "type":"string", "description":"The workspace code of a project that has other projects that it relies on for support.#project invalid inputs", "exampleSetFlag":false, "types":[ "string" ] }, "dependentProjectCode":{ "type":"string", "description":"The project code of a project that has other projects that it relies on for support.", "exampleSetFlag":false, "types":[ "string" ] }, "projectWorkspaceCode":{ "type":"string", "description":"The workspace code of a project that has other projects depending on it.", "exampleSetFlag":false, "types":[ "string" ] }, "projectDependencyId":{ "type":"integer", "description":"The unique identifier of a project dependency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dependentProjectId":{ "type":"integer", "description":"The unique identifier of a project that has other projects that it relies on for support.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "type":"string", "description":"The project code of a project that has other projects depending on it.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project that has other projects depending on it.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProjectRankIdentifier":{ "title":"ProjectRankIdentifier", "type":"object", "properties":{ "evaluationCategoryId":{ "type":"integer", "description":"Evaluation category ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "evaluationSubCategoryId":{ "type":"integer", "description":"Evaluation subcategory ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRankId":{ "type":"integer", "description":"The system-generated identifier of the project rank.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier of the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProjectResourceWorkRateIdentifier":{ "title":"ProjectResourceWorkRateIdentifier", "type":"object", "properties":{ "projectResourceWorkRateId":{ "type":"integer", "description":"The unique identifier of a project work rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectResourceId":{ "type":"integer", "description":"The unique identifier of a project resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "effectiveStartDate":{ "type":"string", "description":"Date that the corresponding units/time period and rates go into effect for the resource or role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "type":"string", "description":"The code of a resource of a project resource.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ProjectRiskIdentifier":{ "title":"ProjectRiskIdentifier", "type":"object", "properties":{ "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ReasonIdentifier":{ "title":"ReasonIdentifier", "type":"object", "properties":{ "reasonId":{ "type":"integer", "description":"The unique identifier of a reason.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reasonName":{ "maxLength":255, "type":"string", "description":"The name of the reason for recommitting to a task.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "RelationshipIdentifier":{ "title":"RelationshipIdentifier", "type":"object", "properties":{ "relationshipId":{ "type":"integer", "description":"The system-generated identifier of an activity relationship.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "predActivityId":{ "type":"integer", "description":"The unique identifier of the predecessor of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "succActivityId":{ "type":"integer", "description":"The unique identifier of the successor of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "predActivityCode":{ "type":"string", "description":"The code of the predecessor activity.", "exampleSetFlag":false, "types":[ "string" ] }, "succActivityCode":{ "type":"string", "description":"The code of the successor activity.", "exampleSetFlag":false, "types":[ "string" ] }, "predProjectCode":{ "type":"string", "description":"The code of the project of the predecessor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "succProjectCode":{ "type":"string", "description":"The code of the project of the successor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "succWorkspaceCode":{ "type":"string", "description":"The code of the workspace of the successor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "predWorkspaceCode":{ "type":"string", "description":"The code of the workspace of the predecessor of an activity.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ReportCycleIdentifier":{ "title":"ReportCycleIdentifier", "type":"object", "properties":{ "reportCycleId":{ "type":"integer", "description":"The unique identifier of a report cycle.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cycleName":{ "maxLength":255, "type":"string", "description":"The name of the reporting cycle.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ResourceDemandIdentifier":{ "title":"ResourceDemandIdentifier", "type":"object", "properties":{ "resourceDemandId":{ "type":"integer", "description":"The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ResourceRoleAssignmentIdentifier":{ "title":"ResourceRoleAssignmentIdentifier", "type":"object", "properties":{ "resourceRoleAssignmentId":{ "type":"integer", "description":"The system-generated identifier of the resource role assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "roleCode":{ "type":"string", "description":"The user-specified identifier of the role.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "roleId":{ "type":"integer", "description":"The unique identifier for the role.The role object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ResourceWorkRateIdentifier":{ "title":"ResourceWorkRateIdentifier", "type":"object", "properties":{ "resourceWorkRateId":{ "type":"integer", "description":"The system-generated identifier of the work rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceResourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "effectiveStartDate":{ "type":"string", "description":"Date that the corresponding units/time period and rates go into effect for the resource or role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "RiskMatrixIdentifier":{ "title":"RiskMatrixIdentifier", "type":"object", "properties":{ "riskMatrixId":{ "type":"integer", "description":"The system-generated identifier of the risk matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "matrixName":{ "maxLength":60, "type":"string", "description":"The name of the risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "RiskMitigationIdentifier":{ "title":"RiskMitigationIdentifier", "type":"object", "properties":{ "riskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMitigationCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "RiskScoreTypeIdentifier":{ "title":"RiskScoreTypeIdentifier", "type":"object", "properties":{ "riskScoreTypeName":{ "maxLength":255, "type":"string", "description":"The name of the risk score type.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The unique identifier of a score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "RiskWeatherPeriodIdentifier":{ "title":"RiskWeatherPeriodIdentifier", "type":"object", "properties":{ "riskWeatherPeriodId":{ "type":"integer", "description":"The system-generated identifier for the period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodName":{ "maxLength":255, "type":"string", "description":"The name of the period.", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "RuleOfCreditIdentifier":{ "title":"RuleOfCreditIdentifier", "type":"object", "properties":{ "rocName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the rule of credit.", "exampleSetFlag":false, "types":[ "string" ] }, "rocId":{ "type":"integer", "description":"Unique identifier of the rule of credit.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ScopeAssignmentActualsTimePhasedDataIdentifier":{ "title":"ScopeAssignmentActualsTimePhasedDataIdentifier", "type":"object", "properties":{ "scopeAssignmentActualsTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope actuals time phased data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ScopeAssignmentInstalledTimePhasedDataIdentifier":{ "title":"ScopeAssignmentInstalledTimePhasedDataIdentifier", "type":"object", "properties":{ "scopeAssignmentInstalledTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ScopeAssignmentPlannedTimePhasedDataIdentifier":{ "title":"ScopeAssignmentPlannedTimePhasedDataIdentifier", "type":"object", "properties":{ "scopeAssignmentPlannedTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ScopeItemAssignmentActivityIdentifier":{ "title":"ScopeItemAssignmentActivityIdentifier", "type":"object", "properties":{ "scopeItemAssignmentActivityId":{ "type":"integer", "description":"The system-generated identifier of a scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignmentCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "StrategyIdentifier":{ "title":"StrategyIdentifier", "type":"object", "properties":{ "strategyId":{ "type":"integer", "description":"The system-generated identifier of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyName":{ "type":"string", "description":"The name of a strategy.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "StrategyTypeIdentifier":{ "title":"StrategyTypeIdentifier", "type":"object", "properties":{ "levelName":{ "type":"string", "description":"The name of a strategy.", "exampleSetFlag":false, "types":[ "string" ] }, "strategyTypeId":{ "type":"integer", "description":"The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "UnitsOfMeasureIdentifier":{ "title":"UnitsOfMeasureIdentifier", "type":"object", "properties":{ "key":{ "maxLength":60, "type":"string", "description":"The abbreviation for the unit of measure name.", "exampleSetFlag":false, "types":[ "string" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unique identifier for the unit of measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "WorkManagerTaskIdentifier":{ "title":"WorkManagerTaskIdentifier", "type":"object", "properties":{ "workManagerTaskId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier assigned to the task.", "exampleSetFlag":false, "types":[ "string" ] }, "project":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "WorkspaceIdentifier":{ "title":"WorkspaceIdentifier", "type":"object", "properties":{ "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityActivityFavorite":{ "title":"ApiEntityActivityFavorite", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "applicationUser":{ "type":"integer", "description":"Unique identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activity":{ "type":"integer", "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityFavoriteId":{ "type":"integer", "description":"The unique identifier of an activity favorite.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The username a user uses to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityActivityFavoriteInput":{ "title":"ApiEntityActivityFavoriteInput", "required":[ "activity", "applicationUser" ], "type":"object", "properties":{ "applicationUser":{ "type":"integer", "description":"Unique identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activity":{ "type":"integer", "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityFavoriteId":{ "type":"integer", "description":"The unique identifier of an activity favorite.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The username a user uses to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ActivityFavorite object, a unique ActivityFavorite object can be identified by the following combinations of the fields.
                      • activityFavoriteId
                      • activity,applicationUser
                      • activityCode,projectCode,workspaceCode,applicationUser
                      • activity,userName
                      • activityCode,projectCode,workspaceCode,userName
                        • ", "exampleSetFlag":false }, "ApiEntityActivityRisk":{ "title":"ApiEntityActivityRisk", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "quantifiedOtherImpacts":{ "type":"array", "description":"Activity risk impacts associated with the activity.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityRiskQuantifiedOtherImpact", "exampleSetFlag":false }, "types":[ "array" ] }, "activityRiskId":{ "type":"integer", "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The unique identifier of an activity assigned to a risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The unique identifier for the project risk.The project risk object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityActivityRiskQuantifiedOtherImpact":{ "title":"ApiEntityActivityRiskQuantifiedOtherImpact", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "shape":{ "type":"string", "description":"The distribution that best models the three-point estimates for risk probabilities.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "minimum":{ "type":"number", "description":"The minimum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "maximum":{ "type":"number", "description":"The maximum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedOtherImpactId":{ "type":"integer", "description":"The unique identifier for the Activity Risk Impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scoreType":{ "type":"string", "description":"The name of the risk score type.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ] }, "mostLikely":{ "type":"number", "description":"The most likely probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "preOrPostResponse":{ "type":"string", "description":"The type of risk analysis scenario run on the project.
                        Pre-Response: A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                        Post-Response: A quantitative risk analysis that takes into account the impact of defined risk response plans.
                        Pre- and Post-Response: A quantitative risk analysis that uses both scenarios.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_RESPONSE", "POST_RESPONSE" ] }, "activityRiskId":{ "type":"integer", "description":"The unique identifier of the activity risk to which the risk is assigned.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityActivityRiskInput":{ "title":"ApiEntityActivityRiskInput", "required":[ "activityId", "projectRiskId" ], "type":"object", "properties":{ "projectName":{ "maxLength":255, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "quantifiedOtherImpacts":{ "type":"array", "description":"Activity risk impacts associated with the activity.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityActivityRiskQuantifiedOtherImpactInput", "exampleSetFlag":false }, "types":[ "array" ] }, "activityRiskId":{ "type":"integer", "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The unique identifier of an activity assigned to a risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The unique identifier for the project risk.The project risk object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ActivityRisk object, a unique ActivityRisk object can be identified by the following combinations of the fields.
                        • activityRiskId
                        • activityId,projectRiskId
                        • activityCode,projectCode,workspaceCode,projectRiskId
                        • activityId,projectCode,workspaceCode,riskCode
                        • activityCode,projectCode,workspaceCode,riskCode
                        • activityCode,projectId,projectRiskId
                        • activityId,projectId,riskCode
                        • activityCode,projectId,riskCode
                          • ", "exampleSetFlag":false }, "ApiEntityActivityRiskQuantifiedOtherImpactInput":{ "title":"ApiEntityActivityRiskQuantifiedOtherImpactInput", "required":[ "preOrPostResponse", "scoreType", "shape" ], "type":"object", "properties":{ "shape":{ "type":"string", "description":"The distribution that best models the three-point estimates for risk probabilities.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "minimum":{ "type":"number", "description":"The minimum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "maximum":{ "type":"number", "description":"The maximum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedOtherImpactId":{ "type":"integer", "description":"The unique identifier for the Activity Risk Impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scoreType":{ "type":"string", "description":"The name of the risk score type.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ] }, "mostLikely":{ "type":"number", "description":"The most likely probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "preOrPostResponse":{ "type":"string", "description":"The type of risk analysis scenario run on the project.
                          Pre-Response: A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                          Post-Response: A quantitative risk analysis that takes into account the impact of defined risk response plans.
                          Pre- and Post-Response: A quantitative risk analysis that uses both scenarios.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_RESPONSE", "POST_RESPONSE" ] }, "activityRiskId":{ "type":"integer", "description":"The unique identifier of the activity risk to which the risk is assigned.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityTestConnectionResponse":{ "title":"ApiEntityTestConnectionResponse", "type":"object", "properties":{ "message":{ "type":"string", "description":"Response from Server. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityApplicationUserGroup":{ "title":"ApiEntityApplicationUserGroup", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeId":{ "type":"integer", "description":"The unique identifier of a project/workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "ldapGuid":{ "maxLength":255, "minLength":0, "type":"string", "description":"Globally unique identifier of an LDAP service.", "exampleSetFlag":false, "types":[ "string" ] }, "applicationUserGroupId":{ "type":"integer", "description":"The unique identifier of a user group. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "groupName":{ "maxLength":255, "minLength":0, "type":"string", "description":"Name of a user group.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project/workspace set by the user who created the project/workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "type":"string", "description":"Type of a user group.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT", "WORKSPACE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityApplicationUserGroupInput":{ "title":"ApiEntityApplicationUserGroupInput", "required":[ "groupName", "scope", "scopeId", "workspaceId" ], "type":"object", "properties":{ "scopeId":{ "type":"integer", "description":"The unique identifier of a project/workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "applicationUserGroupId":{ "type":"integer", "description":"The unique identifier of a user group. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "groupName":{ "maxLength":255, "minLength":0, "type":"string", "description":"Name of a user group.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project/workspace set by the user who created the project/workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "type":"string", "description":"Type of a user group.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT", "WORKSPACE" ] } }, "description":"This entity represents a ApplicationUserGroup object, a unique ApplicationUserGroup object can be identified by the following combinations of the fields.
                          • applicationUserGroupId
                          • groupName,scopeId,workspaceId
                          • groupName,scopeId,workspaceCode
                          • groupName,scopeCode,workspaceId
                          • groupName,scopeCode,workspaceCode
                            • ", "exampleSetFlag":false }, "ApiEntityApplicationUserSetting":{ "title":"ApiEntityApplicationUserSetting", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "applicationUserSettingId":{ "type":"integer", "description":"The unique identifier of a user's settings.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "namespace":{ "maxLength":255, "minLength":1, "type":"string", "description":"The namespace to which a user is assigned.", "exampleSetFlag":false, "types":[ "string" ] }, "settingName":{ "type":"string", "description":"The name of a user setting.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ActivitiesViewSettings", "ActivityNetworkSettings", "ReportsSummaryGridViewConfig", "DecimalPlaces", "NumberDecimalPlaces", "CurrencySymbol", "FourDigitYear", "LeadingZeros", "MonthName", "Separator", "DateFormat", "DigitGroupingSeparator", "DecimalSeparator", "DigitGroupingAndDecimalSymbols", "DigitGroupingStyle", "CurrencyNegativeFormat", "CurrencyPositiveFormat", "TabOrder", "AppVisibilityAndOrder", "ProjectCodesViewConfig", "ProfileImage", "ReportColWidth", "ReportScheduleColWidth", "ScheduleColWidth", "WorkspaceAndProjectDisplayFormat", "CodeValueDisplayFormat", "AnnouncementsLastReadTime", "LocationsViewConfig", "workflowTasksPrefs", "WorkflowViewLogViewConfig", "monitorWorkflowsPrefs", "startWorkflowsPrefs", "workflowDesignsPrefs", "workflowConfigsPrefs", "monitorWorkflowTasksPrefs", "formTemplatesPrefs", "formPreviewPrefs", "userDashboardPref", "SearchAll", "SearchWorkspaces", "SearchProjects", "SearchScopeItems", "SearchProjectCodes", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "SearchIdeas", "SearchPrograms", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "DataDateInPageBanners", "ActualDateIndicator", "ConstraintDateIndicator", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "WhenResourceAndRoleShareActivityAssignment", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions", "HomeRecentsVisible", "UserFirstName", "UserLastName", "UserTitle", "UserLocale", "UserAlternateEmail", "UserPhoneNumber", "UserMobileNumber", "UserFaxNumber", "UserDisplayDensity", "UserTimeZone", "OnboardedForVersion", "WorkPlanGettingStartedShown", "CookiesAcknowledged", "PlaAccepted", "LastSearchIndexRequest", "displayScheduleLog", "LastAccessedWorkPackageId", "LastSearchIndexCompleted", "ExperimentalEnhancedPrint", "ExperimentalColumnMenu", "AutoSaveNamedViews" ] }, "settingValue":{ "maxLength":4000, "minLength":1, "type":"string", "description":"The value of a user setting.", "exampleSetFlag":false, "types":[ "string" ] }, "applicationUserId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityApplicablePreferenceValues":{ "title":"ApiEntityApplicablePreferenceValues", "type":"object", "properties":{ "applicableValues":{ "type":"array", "description":"The list of applicable values for the user preference.
                            Note: For userPreferenceType = DateFormat, applicableValues
                            0 denotes Month, Day, Year
                            1 denotes Day, Month, Year
                            2 denotes Year, Month, Day", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "userPreferenceType":{ "type":"string", "description":"The name of a user setting.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ActivitiesViewSettings", "ActivityNetworkSettings", "ReportsSummaryGridViewConfig", "DecimalPlaces", "NumberDecimalPlaces", "CurrencySymbol", "FourDigitYear", "LeadingZeros", "MonthName", "Separator", "DateFormat", "DigitGroupingSeparator", "DecimalSeparator", "DigitGroupingAndDecimalSymbols", "DigitGroupingStyle", "CurrencyNegativeFormat", "CurrencyPositiveFormat", "TabOrder", "AppVisibilityAndOrder", "ProjectCodesViewConfig", "ProfileImage", "ReportColWidth", "ReportScheduleColWidth", "ScheduleColWidth", "WorkspaceAndProjectDisplayFormat", "CodeValueDisplayFormat", "AnnouncementsLastReadTime", "LocationsViewConfig", "workflowTasksPrefs", "WorkflowViewLogViewConfig", "monitorWorkflowsPrefs", "startWorkflowsPrefs", "workflowDesignsPrefs", "workflowConfigsPrefs", "monitorWorkflowTasksPrefs", "formTemplatesPrefs", "formPreviewPrefs", "userDashboardPref", "SearchAll", "SearchWorkspaces", "SearchProjects", "SearchScopeItems", "SearchProjectCodes", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "SearchIdeas", "SearchPrograms", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "DataDateInPageBanners", "ActualDateIndicator", "ConstraintDateIndicator", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "WhenResourceAndRoleShareActivityAssignment", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions", "HomeRecentsVisible", "UserFirstName", "UserLastName", "UserTitle", "UserLocale", "UserAlternateEmail", "UserPhoneNumber", "UserMobileNumber", "UserFaxNumber", "UserDisplayDensity", "UserTimeZone", "OnboardedForVersion", "WorkPlanGettingStartedShown", "CookiesAcknowledged", "PlaAccepted", "LastSearchIndexRequest", "displayScheduleLog", "LastAccessedWorkPackageId", "LastSearchIndexCompleted", "ExperimentalEnhancedPrint", "ExperimentalColumnMenu", "AutoSaveNamedViews" ] }, "minimumRange":{ "type":"string", "description":"The minimum allowed value for the given user preference.", "exampleSetFlag":false, "types":[ "string" ] }, "maximumRange":{ "type":"string", "description":"The maximum allowed value for the given user preference.", "exampleSetFlag":false, "types":[ "string" ] }, "isDependentType":{ "type":"boolean", "description":"Indicates whether the user preference is dependent on another user preference.", "exampleSetFlag":false, "types":[ "boolean" ] }, "dependentPreference":{ "type":"string", "description":"The user preference on which this preference is dependent.", "exampleSetFlag":false, "types":[ "string" ] }, "applicableType":{ "type":"string", "description":"The type of user preference value.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityApplicationUserSettingInput":{ "title":"ApiEntityApplicationUserSettingInput", "type":"object", "properties":{ "applicationUserSettingId":{ "type":"integer", "description":"The unique identifier of a user's settings.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "settingName":{ "type":"string", "description":"The name of a user setting.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ActivitiesViewSettings", "ActivityNetworkSettings", "ReportsSummaryGridViewConfig", "DecimalPlaces", "NumberDecimalPlaces", "CurrencySymbol", "FourDigitYear", "LeadingZeros", "MonthName", "Separator", "DateFormat", "DigitGroupingSeparator", "DecimalSeparator", "DigitGroupingAndDecimalSymbols", "DigitGroupingStyle", "CurrencyNegativeFormat", "CurrencyPositiveFormat", "TabOrder", "AppVisibilityAndOrder", "ProjectCodesViewConfig", "ProfileImage", "ReportColWidth", "ReportScheduleColWidth", "ScheduleColWidth", "WorkspaceAndProjectDisplayFormat", "CodeValueDisplayFormat", "AnnouncementsLastReadTime", "LocationsViewConfig", "workflowTasksPrefs", "WorkflowViewLogViewConfig", "monitorWorkflowsPrefs", "startWorkflowsPrefs", "workflowDesignsPrefs", "workflowConfigsPrefs", "monitorWorkflowTasksPrefs", "formTemplatesPrefs", "formPreviewPrefs", "userDashboardPref", "SearchAll", "SearchWorkspaces", "SearchProjects", "SearchScopeItems", "SearchProjectCodes", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "SearchIdeas", "SearchPrograms", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "DataDateInPageBanners", "ActualDateIndicator", "ConstraintDateIndicator", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "WhenResourceAndRoleShareActivityAssignment", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions", "HomeRecentsVisible", "UserFirstName", "UserLastName", "UserTitle", "UserLocale", "UserAlternateEmail", "UserPhoneNumber", "UserMobileNumber", "UserFaxNumber", "UserDisplayDensity", "UserTimeZone", "OnboardedForVersion", "WorkPlanGettingStartedShown", "CookiesAcknowledged", "PlaAccepted", "LastSearchIndexRequest", "displayScheduleLog", "LastAccessedWorkPackageId", "LastSearchIndexCompleted", "ExperimentalEnhancedPrint", "ExperimentalColumnMenu", "AutoSaveNamedViews" ] }, "settingValue":{ "maxLength":4000, "minLength":1, "type":"string", "description":"The value of a user setting.", "exampleSetFlag":false, "types":[ "string" ] }, "applicationUserId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ApplicationUserSetting object, a unique ApplicationUserSetting object can be identified by the following combinations of the fields.
                            • applicationUserSettingId
                            • applicationUserId,settingName
                              • ", "exampleSetFlag":false }, "ApiEntityAssignment":{ "title":"ApiEntityAssignment", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "estimateAtCompletionUnits":{ "type":"number", "description":"The estimated units at completion of the assignment.
                              ", "format":"double", "exampleSetFlag":false }, "estimateToCompletionUnits":{ "type":"number", "description":"The estimated quantity to complete the assignment.
                              ", "format":"double", "exampleSetFlag":false }, "calculateCostFromUnitsFlag":{ "type":"boolean", "description":"Indicates whether to calculate costs based on units for an assignment.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualUnitsCurve":{ "type":"string", "description":"The manual curve for actual units on the assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinish":{ "type":"string", "description":"The date the assignment is scheduled to be finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStart":{ "type":"string", "description":"The date the assignment is scheduled to begin.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStart":{ "type":"string", "description":"The latest possible date the assignment must begin to not delay the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinish":{ "type":"string", "description":"The latest possible date the assignment must be finished to not delay the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "assignmentFinancial":{ "description":"List all assignment cost field spread data assigned to the assignment.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityAssignmentFinancial" } ] }, "assignmentManualCurve":{ "description":"List the manual curve for planned and remaining units on the assignment.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityAssignmentManualCurve" } ] }, "resourceCurve":{ "description":"The resource's units and costs distributed over the duration of an activity.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCurve" } ] }, "plannedDuration":{ "type":"number", "description":"The resource's total working time on the activity from the Planned Start date to the Planned Finish date.", "format":"double", "exampleSetFlag":false }, "schedulePercentComplete":{ "type":"number", "description":"The assignment schedule percent complete, which specifies how much of the assignment's project baseline duration is complete so far.
                              ", "format":"double", "exampleSetFlag":false }, "unitsPercentComplete":{ "type":"number", "description":"The percent complete of units for the resource assignment on the activity.", "format":"double", "exampleSetFlag":false }, "plannedStart":{ "type":"string", "description":"The planned start date for the assignment on the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The date the assignment is scheduled to be finished. It is calculated by the scheduler and will not change once the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"If the activity has started, the date work began on the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The date on which the assignment was completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class of the resource of an assignment. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "assignmentId":{ "type":"integer", "description":"The system-generated identifier of an assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "assignmentCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"A unique identifier for the assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedLag":{ "type":"number", "description":"The planned time lag between the activity's planned start date and the resource's planned start date on the activity.", "format":"double", "exampleSetFlag":false }, "earnedValueUnits":{ "type":"number", "description":"The portion of baseline labor units that are complete as of the project data date.", "format":"double", "exampleSetFlag":false }, "plannedValueUnits":{ "type":"number", "description":"The product of the budget at completion and the schedule percent complete.", "format":"double", "exampleSetFlag":false }, "plannedUnitsPerHour":{ "type":"number", "description":"The planned units per time at which the resource is to perform work on the activity.", "format":"double", "exampleSetFlag":false }, "driveActivityDates":{ "type":"boolean", "description":"Determines whether new resource or role assignments determine activity dates.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualUnits":{ "type":"number", "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.", "format":"double", "exampleSetFlag":false }, "plannedUnits":{ "type":"number", "description":"The planned units of work for the resource assignment on the activity.", "format":"double", "exampleSetFlag":false }, "baselineUnits":{ "type":"number", "description":"The number of baseline units for the activity.", "format":"double", "exampleSetFlag":false }, "unstaffedRemainingUnits":{ "type":"number", "description":"The number of unstaffed units remaining for one or more resource assignments.", "format":"double", "exampleSetFlag":false }, "rateType":{ "type":"string", "description":"The type of rate that defines the activity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CUSTOM", "PRICE_PER_UNIT_1", "PRICE_PER_UNIT_2", "PRICE_PER_UNIT_3", "PRICE_PER_UNIT_4", "PRICE_PER_UNIT_5" ] }, "atCompletionUnits":{ "type":"number", "description":"The sum of the actual units and remaining units for the resource assignment on the activity.
                              Calculated as Actual Units plus Remaining Units.", "format":"double", "exampleSetFlag":false }, "remainingLag":{ "type":"number", "description":"The time lag between the activity's remaining start date and the resource's remaining start date on the activity.", "format":"double", "exampleSetFlag":false }, "remainingUnitsPerHour":{ "type":"number", "description":"The units per time required for the resource assignment to complete the activity.", "format":"double", "exampleSetFlag":false }, "pricePerUnitSourceType":{ "type":"string", "description":"The value that indicates which Price/Unit will be used to calculate costs for the assignment. Valid options are Resource, Role, or Override.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE", "OVERRIDE" ] }, "actualThisPeriodUnits":{ "type":"number", "description":"The actual cost of an activity resource assignment during this period.", "format":"double", "exampleSetFlag":false }, "remainingUnits":{ "type":"number", "description":"The remaining units of work to be performed by the resource on the activity.", "format":"double", "exampleSetFlag":false }, "staffedRemainingUnits":{ "type":"number", "description":"The number of staff units remaining for one or more resource assignments.", "format":"double", "exampleSetFlag":false }, "proficiency":{ "type":"string", "description":"The skill level of the resource an activity is assigned to. The valid values are Master, Expert, Skilled, Proficient, and Inexperienced.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ONE", "TWO", "THREE", "FOUR", "FIVE" ] }, "totalRemainingLag":{ "type":"number", "description":"The sum of expired lag and remaining lag for the activity.", "format":"double", "exampleSetFlag":false }, "resourceRoleCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a contract.", "exampleSetFlag":false, "types":[ "string" ] }, "curveName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the curve profile.", "exampleSetFlag":false, "types":[ "string" ] }, "priorActualUnits":{ "type":"number", "description":"The total actual units incurred at the time of the last stored period performance. This represents the total units incurred from the last period closeout date.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a resource.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceType":{ "type":"string", "description":"The resource type. Valid values are Labor, Nonlabor, and Material.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LABOR", "NONLABOR", "MATERIAL" ] }, "calendarId":{ "type":"integer", "description":"The calendar used to record and track the assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceRoleId":{ "type":"integer", "description":"The identifier for the role assigned to the resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "startDate":{ "type":"string", "description":"The start date for the activity assignment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The finish date for the assignment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The remaining working time for the resource assignment on the activity, from the resource's remaining start date to the remaining finish date.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The activity code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "actualDuration":{ "type":"number", "description":"The total working time from the assignment actual start date to the actual finish date for completed assignments, or the total working time from the actual start date to the data date for in-progress assignments.", "format":"double", "exampleSetFlag":false }, "atCompletionDuration":{ "type":"number", "description":"The total working time from the assignment's current start date to the current finish date.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for an assignment.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "starred":{ "type":"boolean", "description":"Specifies whether the assignment has been marked as important.", "exampleSetFlag":false, "types":[ "boolean" ] }, "curveId":{ "type":"integer", "description":"The resource's units and costs distributed over the duration of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityAssignmentConfiguredFieldValue":{ "title":"ApiEntityAssignmentConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "assignmentConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Assignment Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "assignmentId":{ "type":"integer", "description":"The system-generated identifier of an assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityAssignmentFinancial":{ "title":"ApiEntityAssignmentFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "resource":{ "type":"integer", "description":"The system-generated identifier of a resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualThisPeriodCostProject":{ "type":"number", "description":"The labor, nonlabor, and material costs incurred during the current financial period. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "staffedRemainingCostProject":{ "type":"number", "description":"The remaining cost for resource assignments that have a filled role. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unstaffedRemainingCostProject":{ "type":"number", "description":"The remaining cost for resource assignments that do not have a filled role. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "activity":{ "type":"integer", "description":"The system-generated identifier of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualCostProject":{ "type":"number", "description":"The actual cost for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCost":{ "type":"number", "description":"The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedValueCostProject":{ "type":"number", "description":"The approved budget for work actually completed by the specified project data date. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostProject":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCost":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a project. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedValueCost":{ "type":"number", "description":"The remaining cost for resource assignments that have a filled role. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedCostProject":{ "type":"number", "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingCostProject":{ "type":"number", "description":"The remaining cost for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "assignmentId":{ "type":"integer", "description":"The unique identifier for the assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unstaffedRemainingCost":{ "type":"number", "description":"The remaining cost for resource assignments that do not have a filled role. This field is in base currency and is calculated from unstaffedRemainingCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pricePerUnit":{ "minimum":0, "type":"number", "description":"The price per unit of time for the resource or role. This field is in base currency and is calculated from pricePerUnitProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "staffedRemainingCost":{ "type":"number", "description":"The remaining cost for resource assignments that have a filled role. This field is in base currency and is calculated from staffedRemainingCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodCost":{ "type":"number", "description":"The labor, nonlabor, and material costs incurred during the current financial period. This field is in base currency and is calculated from actualThisPeriodCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pricePerUnitProject":{ "minimum":0, "type":"number", "description":"The price per unit of time for the resource or role. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "priorActualCost":{ "type":"number", "description":"The total actual costs incurred at the time of the last stored period performance. This field is in base currency and is calculated from priorActualCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "priorActualCostProject":{ "type":"number", "description":"The total actual costs incurred at the time of the last stored period performance. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "plannedCost":{ "type":"number", "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "project":{ "type":"integer", "description":"The system-generated identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityAssignmentManualCurve":{ "title":"ApiEntityAssignmentManualCurve", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "plannedUnitsCurve":{ "maxLength":4000, "type":"string", "description":"The manual curve for planned units on the assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "remainingUnitsCurve":{ "maxLength":4000, "type":"string", "description":"The manual curve for remaining units on the assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "assignmentId":{ "type":"integer", "description":"The unique identifier for the assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCurve":{ "title":"ApiEntityCurve", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "curveName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the curve profile.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"It describes how data is shared between parent and child workspaces.
                              Manual: Data can be pulled down by child workspaces. This is the default option.
                              Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the curve and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "buckets":{ "type":"array", "description":"The buckets of a cost curve.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurveBucket", "exampleSetFlag":false }, "types":[ "array" ] }, "curveId":{ "type":"integer", "description":"The unique identifier of a curve.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCurveBucket":{ "title":"ApiEntityCurveBucket", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "value":{ "type":"number", "description":"Numeric value of a bucket curve. Curve bucket values determine the shape of curves.", "exampleSetFlag":false, "types":[ "number" ] }, "curveBucketId":{ "type":"integer", "description":"The unique identifier of a curve bucket.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "bucketLevel":{ "type":"integer", "description":"The level of a curve bucket.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "curveId":{ "type":"integer", "description":"The unique identifier of a curve.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityAssignmentConfiguredFieldValueInput":{ "title":"ApiEntityAssignmentConfiguredFieldValueInput", "type":"object", "properties":{ "assignmentConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Assignment Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "assignmentId":{ "type":"integer", "description":"The system-generated identifier of an assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a AssignmentConfiguredFieldValue object, a unique AssignmentConfiguredFieldValue object can be identified by the following combinations of the fields.
                              • assignmentConfiguredFieldValueId
                              • columnDefinitionId
                              • columnName
                              • columnLabel
                                • ", "exampleSetFlag":false }, "ApiEntityAssignmentFinancialInput":{ "title":"ApiEntityAssignmentFinancialInput", "type":"object", "properties":{ "resource":{ "type":"integer", "description":"The system-generated identifier of a resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualThisPeriodCostProject":{ "type":"number", "description":"The labor, nonlabor, and material costs incurred during the current financial period. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "activity":{ "type":"integer", "description":"The system-generated identifier of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualCostProject":{ "type":"number", "description":"The actual cost for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCost":{ "type":"number", "description":"The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedCostProject":{ "type":"number", "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingCostProject":{ "type":"number", "description":"The remaining cost for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "assignmentId":{ "type":"integer", "description":"The unique identifier for the assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pricePerUnit":{ "minimum":0, "type":"number", "description":"The price per unit of time for the resource or role. This field is in base currency and is calculated from pricePerUnitProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualThisPeriodCost":{ "type":"number", "description":"The labor, nonlabor, and material costs incurred during the current financial period. This field is in base currency and is calculated from actualThisPeriodCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pricePerUnitProject":{ "minimum":0, "type":"number", "description":"The price per unit of time for the resource or role. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedCost":{ "type":"number", "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "project":{ "type":"integer", "description":"The system-generated identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityAssignmentInput":{ "title":"ApiEntityAssignmentInput", "required":[ "activityId", "resourceId" ], "type":"object", "properties":{ "calculateCostFromUnitsFlag":{ "type":"boolean", "description":"Indicates whether to calculate costs based on units for an assignment.", "exampleSetFlag":false, "types":[ "boolean" ] }, "remainingFinish":{ "type":"string", "description":"The date the assignment is scheduled to be finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStart":{ "type":"string", "description":"The date the assignment is scheduled to begin.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStart":{ "type":"string", "description":"The latest possible date the assignment must begin to not delay the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinish":{ "type":"string", "description":"The latest possible date the assignment must be finished to not delay the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "assignmentFinancial":{ "description":"List all assignment cost field spread data assigned to the assignment.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityAssignmentFinancialInput" } ] }, "resourceCurve":{ "description":"The resource's units and costs distributed over the duration of an activity.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCurveInput" } ] }, "plannedDuration":{ "type":"number", "description":"The resource's total working time on the activity from the Planned Start date to the Planned Finish date.", "format":"double", "exampleSetFlag":false }, "schedulePercentComplete":{ "type":"number", "description":"The assignment schedule percent complete, which specifies how much of the assignment's project baseline duration is complete so far.
                                ", "format":"double", "exampleSetFlag":false }, "unitsPercentComplete":{ "type":"number", "description":"The percent complete of units for the resource assignment on the activity.", "format":"double", "exampleSetFlag":false }, "plannedStart":{ "type":"string", "description":"The planned start date for the assignment on the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The date the assignment is scheduled to be finished. It is calculated by the scheduler and will not change once the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"If the activity has started, the date work began on the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The date on which the assignment was completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class of the resource of an assignment. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "assignmentId":{ "type":"integer", "description":"The system-generated identifier of an assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "assignmentCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"A unique identifier for the assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedLag":{ "type":"number", "description":"The planned time lag between the activity's planned start date and the resource's planned start date on the activity.", "format":"double", "exampleSetFlag":false }, "plannedUnitsPerHour":{ "type":"number", "description":"The planned units per time at which the resource is to perform work on the activity.", "format":"double", "exampleSetFlag":false }, "driveActivityDates":{ "type":"boolean", "description":"Determines whether new resource or role assignments determine activity dates.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualUnits":{ "type":"number", "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.", "format":"double", "exampleSetFlag":false }, "plannedUnits":{ "type":"number", "description":"The planned units of work for the resource assignment on the activity.", "format":"double", "exampleSetFlag":false }, "rateType":{ "type":"string", "description":"The type of rate that defines the activity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CUSTOM", "PRICE_PER_UNIT_1", "PRICE_PER_UNIT_2", "PRICE_PER_UNIT_3", "PRICE_PER_UNIT_4", "PRICE_PER_UNIT_5" ] }, "atCompletionUnits":{ "type":"number", "description":"The sum of the actual units and remaining units for the resource assignment on the activity.
                                Calculated as Actual Units plus Remaining Units.", "format":"double", "exampleSetFlag":false }, "remainingLag":{ "type":"number", "description":"The time lag between the activity's remaining start date and the resource's remaining start date on the activity.", "format":"double", "exampleSetFlag":false }, "remainingUnitsPerHour":{ "type":"number", "description":"The units per time required for the resource assignment to complete the activity.", "format":"double", "exampleSetFlag":false }, "pricePerUnitSourceType":{ "type":"string", "description":"The value that indicates which Price/Unit will be used to calculate costs for the assignment. Valid options are Resource, Role, or Override.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE", "OVERRIDE" ] }, "actualThisPeriodUnits":{ "type":"number", "description":"The actual cost of an activity resource assignment during this period.", "format":"double", "exampleSetFlag":false }, "remainingUnits":{ "type":"number", "description":"The remaining units of work to be performed by the resource on the activity.", "format":"double", "exampleSetFlag":false }, "proficiency":{ "type":"string", "description":"The skill level of the resource an activity is assigned to. The valid values are Master, Expert, Skilled, Proficient, and Inexperienced.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ONE", "TWO", "THREE", "FOUR", "FIVE" ] }, "totalRemainingLag":{ "type":"number", "description":"The sum of expired lag and remaining lag for the activity.", "format":"double", "exampleSetFlag":false }, "curveName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the curve profile.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a resource.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceRoleId":{ "type":"integer", "description":"The identifier for the role assigned to the resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "startDate":{ "type":"string", "description":"The start date for the activity assignment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The finish date for the assignment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The remaining working time for the resource assignment on the activity, from the resource's remaining start date to the remaining finish date.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The activity code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for an assignment.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "curveId":{ "type":"integer", "description":"The resource's units and costs distributed over the duration of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a Assignment object, a unique Assignment object can be identified by the following combinations of the fields.
                                • assignmentId
                                • activityId,resourceId,assignmentCode
                                • activityCode,projectCode,workspaceCode,resourceId,assignmentCode
                                • activityId,workspaceCode,resourceCode,resourceClass,assignmentCode
                                • activityCode,projectCode,workspaceCode,resourceCode,resourceClass,assignmentCode
                                  • ", "exampleSetFlag":false }, "ApiEntityCurveBucketInput":{ "title":"ApiEntityCurveBucketInput", "required":[ "bucketLevel" ], "type":"object", "properties":{ "value":{ "type":"number", "description":"Numeric value of a bucket curve. Curve bucket values determine the shape of curves.", "exampleSetFlag":false, "types":[ "number" ] }, "curveBucketId":{ "type":"integer", "description":"The unique identifier of a curve bucket.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "bucketLevel":{ "type":"integer", "description":"The level of a curve bucket.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "curveId":{ "type":"integer", "description":"The unique identifier of a curve.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCurveInput":{ "title":"ApiEntityCurveInput", "required":[ "curveName", "workspaceId" ], "type":"object", "properties":{ "curveName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the curve profile.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"It describes how data is shared between parent and child workspaces.
                                  Manual: Data can be pulled down by child workspaces. This is the default option.
                                  Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "buckets":{ "type":"array", "description":"The buckets of a cost curve.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCurveBucketInput", "exampleSetFlag":false }, "types":[ "array" ] }, "curveId":{ "type":"integer", "description":"The unique identifier of a curve.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a Curve object, a unique Curve object can be identified by the following combinations of the fields.
                                  • curveId
                                  • curveName,workspaceId
                                  • curveName,workspaceCode
                                    • ", "exampleSetFlag":false }, "ApiEntityBaselineAssignment":{ "title":"ApiEntityBaselineAssignment", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "assignmentFinancial":{ "description":"List all assignment cost field spread data assigned to the assignment.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityAssignmentFinancial" } ] }, "assignmentId":{ "type":"integer", "description":"The system-generated identifier of an assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for an assignment.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignmentConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "estimateAtCompletionUnits":{ "type":"number", "description":"The estimated units at completion of the assignment.
                                    ", "format":"double", "exampleSetFlag":false }, "estimateToCompletionUnits":{ "type":"number", "description":"The estimated quantity to complete the assignment.
                                    ", "format":"double", "exampleSetFlag":false }, "calculateCostFromUnitsFlag":{ "type":"boolean", "description":"Indicates whether to calculate costs based on units for an assignment.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualUnitsCurve":{ "type":"string", "description":"The manual curve for actual units on the assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinish":{ "type":"string", "description":"The date the assignment is scheduled to be finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStart":{ "type":"string", "description":"The date the assignment is scheduled to begin.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStart":{ "type":"string", "description":"The latest possible date the assignment must begin to not delay the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinish":{ "type":"string", "description":"The latest possible date the assignment must be finished to not delay the project finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "assignmentManualCurve":{ "description":"List the manual curve for planned and remaining units on the assignment.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityAssignmentManualCurve" } ] }, "resourceCurve":{ "description":"The resource's units and costs distributed over the duration of an activity.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCurve" } ] }, "plannedDuration":{ "type":"number", "description":"The resource's total working time on the activity from the Planned Start date to the Planned Finish date.", "format":"double", "exampleSetFlag":false }, "schedulePercentComplete":{ "type":"number", "description":"The assignment schedule percent complete, which specifies how much of the assignment's project baseline duration is complete so far.
                                    ", "format":"double", "exampleSetFlag":false }, "unitsPercentComplete":{ "type":"number", "description":"The percent complete of units for the resource assignment on the activity.", "format":"double", "exampleSetFlag":false }, "plannedStart":{ "type":"string", "description":"The planned start date for the assignment on the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The date the assignment is scheduled to be finished. It is calculated by the scheduler and will not change once the activity has started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"If the activity has started, the date work began on the activity.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The date on which the assignment was completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class of the resource of an assignment. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "assignmentCode":{ "maxLength":60, "type":"string", "description":"A unique identifier for the assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedLag":{ "type":"number", "description":"The planned time lag between the activity's planned start date and the resource's planned start date on the activity.", "format":"double", "exampleSetFlag":false }, "earnedValueUnits":{ "type":"number", "description":"The portion of baseline labor units that are complete as of the project data date.", "format":"double", "exampleSetFlag":false }, "plannedValueUnits":{ "type":"number", "description":"The product of the budget at completion and the schedule percent complete.", "format":"double", "exampleSetFlag":false }, "plannedUnitsPerHour":{ "type":"number", "description":"The planned units per time at which the resource is to perform work on the activity.", "format":"double", "exampleSetFlag":false }, "driveActivityDates":{ "type":"boolean", "description":"Determines whether new resource or role assignments determine activity dates.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualUnits":{ "type":"number", "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.", "format":"double", "exampleSetFlag":false }, "plannedUnits":{ "type":"number", "description":"The planned units of work for the resource assignment on the activity.", "format":"double", "exampleSetFlag":false }, "baselineUnits":{ "type":"number", "description":"The number of baseline units for the activity.", "format":"double", "exampleSetFlag":false }, "unstaffedRemainingUnits":{ "type":"number", "description":"The number of unstaffed units remaining for one or more resource assignments.", "format":"double", "exampleSetFlag":false }, "rateType":{ "type":"string", "description":"The type of rate that defines the activity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CUSTOM", "PRICE_PER_UNIT_1", "PRICE_PER_UNIT_2", "PRICE_PER_UNIT_3", "PRICE_PER_UNIT_4", "PRICE_PER_UNIT_5" ] }, "atCompletionUnits":{ "type":"number", "description":"The sum of the actual units and remaining units for the resource assignment on the activity.
                                    Calculated as Actual Units plus Remaining Units.", "format":"double", "exampleSetFlag":false }, "remainingLag":{ "type":"number", "description":"The time lag between the activity's remaining start date and the resource's remaining start date on the activity.", "format":"double", "exampleSetFlag":false }, "remainingUnitsPerHour":{ "type":"number", "description":"The units per time required for the resource assignment to complete the activity.", "format":"double", "exampleSetFlag":false }, "pricePerUnitSourceType":{ "type":"string", "description":"The value that indicates which Price/Unit will be used to calculate costs for the assignment. Valid options are Resource, Role, or Override.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE", "OVERRIDE" ] }, "actualThisPeriodUnits":{ "type":"number", "description":"The actual cost of an activity resource assignment during this period.", "format":"double", "exampleSetFlag":false }, "remainingUnits":{ "type":"number", "description":"The remaining units of work to be performed by the resource on the activity.", "format":"double", "exampleSetFlag":false }, "staffedRemainingUnits":{ "type":"number", "description":"The number of staff units remaining for one or more resource assignments.", "format":"double", "exampleSetFlag":false }, "proficiency":{ "type":"string", "description":"The skill level of the resource an activity is assigned to. The valid values are Master, Expert, Skilled, Proficient, and Inexperienced.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ONE", "TWO", "THREE", "FOUR", "FIVE" ] }, "totalRemainingLag":{ "type":"number", "description":"The sum of expired lag and remaining lag for the activity.", "format":"double", "exampleSetFlag":false }, "resourceRoleCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a contract.", "exampleSetFlag":false, "types":[ "string" ] }, "curveName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the curve profile.", "exampleSetFlag":false, "types":[ "string" ] }, "priorActualUnits":{ "type":"number", "description":"The total actual units incurred at the time of the last stored period performance. This represents the total units incurred from the last period closeout date.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a resource.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceType":{ "type":"string", "description":"The resource type. Valid values are Labor, Nonlabor, and Material.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LABOR", "NONLABOR", "MATERIAL" ] }, "calendarId":{ "type":"integer", "description":"The calendar used to record and track the assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceRoleId":{ "type":"integer", "description":"The identifier for the role assigned to the resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "startDate":{ "type":"string", "description":"The start date for the activity assignment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The finish date for the assignment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The remaining working time for the resource assignment on the activity, from the resource's remaining start date to the remaining finish date.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The activity code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "actualDuration":{ "type":"number", "description":"The total working time from the assignment actual start date to the actual finish date for completed assignments, or the total working time from the actual start date to the data date for in-progress assignments.", "format":"double", "exampleSetFlag":false }, "atCompletionDuration":{ "type":"number", "description":"The total working time from the assignment's current start date to the current finish date.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "starred":{ "type":"boolean", "description":"Specifies whether the assignment has been marked as important.", "exampleSetFlag":false, "types":[ "boolean" ] }, "curveId":{ "type":"integer", "description":"The resource's units and costs distributed over the duration of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityAssignmentFavorite":{ "title":"ApiEntityAssignmentFavorite", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "assignmentFavoriteId":{ "type":"integer", "description":"The unique identifier of an assignment favorite.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "applicationUser":{ "type":"integer", "description":"The unique identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The username a user uses to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class of the resource of an assignment. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "assignmentId":{ "type":"integer", "description":"The unique identifier for the assignment.The assignment object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a resource.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The activity code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityAssignmentFavoriteInput":{ "title":"ApiEntityAssignmentFavoriteInput", "required":[ "applicationUser", "assignmentId" ], "type":"object", "properties":{ "assignmentFavoriteId":{ "type":"integer", "description":"The unique identifier of an assignment favorite.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "applicationUser":{ "type":"integer", "description":"The unique identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The username a user uses to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class of the resource of an assignment. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "assignmentId":{ "type":"integer", "description":"The unique identifier for the assignment.The assignment object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a resource.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The activity code of an assignment.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a AssignmentFavorite object, a unique AssignmentFavorite object can be identified by the following combinations of the fields.
                                    • assignmentFavoriteId
                                    • applicationUser,assignmentId
                                    • activityCode,projectCode,workspaceCode,resourceCode,applicationUser
                                    • activityCode,projectCode,workspaceCode,resourceCode,userName
                                    • assignmentId,userName
                                      • ", "exampleSetFlag":false }, "ApiEntityBaselineCategory":{ "title":"ApiEntityBaselineCategory", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                      Manual: Data can be pulled down by child workspaces. This is the default option.
                                      Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the baseline category and the workspace.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "baselineCategoryId":{ "type":"integer", "description":"The system-generated unique identifier of a baseline category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the baseline category.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBaselineCategoryInput":{ "title":"ApiEntityBaselineCategoryInput", "required":[ "baselineCategoryName", "workspaceId" ], "type":"object", "properties":{ "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                      Manual: Data can be pulled down by child workspaces. This is the default option.
                                      Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "baselineCategoryId":{ "type":"integer", "description":"The system-generated unique identifier of a baseline category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the baseline category.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a BaselineCategory object, a unique BaselineCategory object can be identified by the following combinations of the fields.
                                      • baselineCategoryId
                                      • baselineCategoryName,workspaceId
                                      • baselineCategoryName,workspaceCode
                                        • ", "exampleSetFlag":false }, "ApiEntityStatusTransition":{ "title":"ApiEntityStatusTransition", "type":"object", "properties":{ "comment":{ "maxLength":4000, "type":"string", "description":"Comments included by the user who modified the budget.", "exampleSetFlag":false, "types":[ "string" ] }, "userNames":{ "type":"array", "description":"The users associated with the project budget.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "budgetStatus":{ "type":"string", "description":"The current status of a budget.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetChange":{ "title":"ApiEntityBudgetChange", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "withdrawApprovalByUserId":{ "type":"integer", "description":"The username of the user that with withdrew approval of the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "withdrawApprovalByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who withdrew a project budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetChangeCost":{ "description":"An object containing the cost fields associated with the budget change.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetChangeCost" } ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details supporting the change request.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetChangeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the project budget change request.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransactions":{ "type":"array", "description":"List of all budget transactions for the project budget change.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "submitByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who submitted a project budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "submitDate":{ "type":"string", "description":"Date the item was submitted.", "format":"date-time", "exampleSetFlag":false }, "withdrawApprovalDate":{ "type":"string", "description":"Date the item was withdrawn.", "format":"date-time", "exampleSetFlag":false }, "approveByUserId":{ "type":"integer", "description":"The username of the user that approved the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who approved a project budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "lastModifiedById":{ "type":"integer", "description":"The username of the user who last made changes to the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserId":{ "type":"integer", "description":"The username of the user that rejected the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who rejected a project budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "rejectDate":{ "type":"string", "description":"Date the item was rejected.", "format":"date-time", "exampleSetFlag":false }, "submitByUserId":{ "type":"integer", "description":"The username of the user that submitted the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"Date the item was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget change.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the project budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetChangeConfiguredFieldValue":{ "title":"ApiEntityBudgetChangeConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "budgetChangeConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Budget Change Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetChangeId":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetChangeCost":{ "title":"ApiEntityBudgetChangeCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "totalCost":{ "type":"number", "description":"The cost to be added or subtracted from the project budget. This value is based on the base currency.", "format":"double", "exampleSetFlag":false }, "totalCostProject":{ "type":"number", "description":"The cost to be added or subtracted from the project budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "totalCostWorkspace1":{ "type":"number", "description":"The cost to be added or subtracted from the project budget. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalCostWorkspace2":{ "type":"number", "description":"The cost to be added or subtracted from the project budget. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalCostWorkspace3":{ "type":"number", "description":"The cost to be added or subtracted from the project budget. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "budgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetChangeTransaction":{ "title":"ApiEntityBudgetChangeTransaction", "type":"object", "properties":{ "budgetTransactionCost":{ "description":"The cost of a budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetTransactionCost" } ] }, "budgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a budget transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the budget line item.", "exampleSetFlag":false, "types":[ "string" ] }, "changeMode":{ "type":"string", "description":"The detailed budget change line item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "AUTO", "MANUAL", "CHANGE" ] }, "desiredCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"A unique identifier for the budget item (Add Budget Line).", "exampleSetFlag":false, "types":[ "string" ] }, "budgetChangeId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemCodeSuffix":{ "type":"integer", "description":"The suffix of a budget transaction code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transactionType":{ "type":"string", "description":"Specifies whether the budget row is an original, change, or transfer value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CHANGE", "TRANSFER" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemName":{ "maxLength":255, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "budgetHours":{ "type":"number", "description":"The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.", "format":"double", "exampleSetFlag":false }, "budgetCbsSheetCodeId":{ "type":"integer", "description":"The name of the CBS Code associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetCostCategoryId":{ "type":"integer", "description":"The cost category ID of the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"The date the transaction was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget change transaction.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetTransactionConfiguredFieldValue":{ "title":"ApiEntityBudgetTransactionConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransactionConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Transaction Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransactionId":{ "type":"integer", "description":"The system-generated identifier for a transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetTransactionCost":{ "title":"ApiEntityBudgetTransactionCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a budget transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitRate":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the base currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace1":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace2":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace3":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "unitRateProject":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "laborRate":{ "type":"number", "description":"The cost per labor hour of the budget line item detail. This value is based on the base currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace1":{ "type":"number", "description":"The cost per labor hour of the budget line item detail. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace2":{ "type":"number", "description":"The cost per labor hour of the budget line item detail. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace3":{ "type":"number", "description":"The cost per labor hour of the budget line item detail. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "laborRateProject":{ "type":"number", "description":"The cost per labor hour of the budget line item detail. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentCost":{ "type":"number", "description":"The current cost of the associated budget line item. This value is based on the base currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace1":{ "type":"number", "description":"The current cost of the associated budget line item. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace2":{ "type":"number", "description":"The current cost of the associated budget line item. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace3":{ "type":"number", "description":"The current cost of the associated budget line item. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentCostProject":{ "type":"number", "description":"The current cost of the associated budget line item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "amountCost":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions. This value is based on the base currency.", "format":"double", "exampleSetFlag":false }, "amountCostWorkspace1":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "amountCostWorkspace2":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "amountCostWorkspace3":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "amountCostProject":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetChangeConfiguredFieldValueInput":{ "title":"ApiEntityBudgetChangeConfiguredFieldValueInput", "type":"object", "properties":{ "budgetChangeConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Budget Change Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetChangeId":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a BudgetChangeConfiguredFieldValue object, a unique BudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.
                                        • budgetChangeConfiguredFieldValueId
                                        • columnDefinitionId
                                        • columnName
                                        • columnLabel
                                          • ", "exampleSetFlag":false }, "ApiEntityBudgetChangeInput":{ "title":"ApiEntityBudgetChangeInput", "required":[ "projectId" ], "type":"object", "properties":{ "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details supporting the change request.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetChangeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the project budget change request.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransactions":{ "type":"array", "description":"List of all budget transactions for the project budget change.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeTransactionInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget change.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetChangeConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the project budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] } }, "description":"This entity represents a BudgetChange object, a unique BudgetChange object can be identified by the following combinations of the fields.
                                          • budgetChangeId
                                          • budgetChangeCode,projectId
                                          • budgetChangeCode,projectCode,workspaceCode
                                          • budgetChangeCode,projectBudgetId
                                            • ", "exampleSetFlag":false }, "ApiEntityBudgetChangeTransactionInput":{ "title":"ApiEntityBudgetChangeTransactionInput", "type":"object", "properties":{ "budgetTransactionCost":{ "description":"The cost of a budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetTransactionCostInput" } ] }, "budgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a budget transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the budget line item.", "exampleSetFlag":false, "types":[ "string" ] }, "desiredCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"A unique identifier for the budget item (Add Budget Line).", "exampleSetFlag":false, "types":[ "string" ] }, "budgetChangeId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemName":{ "maxLength":255, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "budgetCbsSheetCodeId":{ "type":"integer", "description":"The name of the CBS Code associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetCostCategoryId":{ "type":"integer", "description":"The cost category ID of the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget change transaction.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a BudgetChangeTransaction object, a unique BudgetChangeTransaction object can be identified by the following combinations of the fields.
                                            • budgetTransactionId
                                              • ", "exampleSetFlag":false }, "ApiEntityBudgetTransactionConfiguredFieldValueInput":{ "title":"ApiEntityBudgetTransactionConfiguredFieldValueInput", "type":"object", "properties":{ "budgetTransactionConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Transaction Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a BudgetTransactionConfiguredFieldValue object, a unique BudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.
                                              • budgetTransactionConfiguredFieldValueId
                                              • columnDefinitionId
                                              • columnName
                                              • columnLabel
                                                • ", "exampleSetFlag":false }, "ApiEntityBudgetTransactionCostInput":{ "title":"ApiEntityBudgetTransactionCostInput", "type":"object", "properties":{ "budgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a budget transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitRateProject":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item detail. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "laborRateProject":{ "type":"number", "description":"The cost per labor hour of the budget line item detail. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "amountCostProject":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions. This value is based on the project currency.", "format":"double", "exampleSetFlag":false } }, "description":"This entity represents a BudgetTransactionCost object, a unique BudgetTransactionCost object can be identified by the following combinations of the fields.
                                                • budgetTransactionId
                                                  • ", "exampleSetFlag":false }, "ApiEntityBudgetChangeStatusTransitionHistory":{ "title":"ApiEntityBudgetChangeStatusTransitionHistory", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Comments included by the user who changed the status of the record.", "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"The date the status of the record was changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "budgetChangeStatusTransitionHistoryId":{ "type":"integer", "description":"The system-generated identifier of a budget change status transition history.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The name of a user associated with the status transition history.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "statusTransitionType":{ "type":"string", "description":"The type of change made to the record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "REJECT", "DRAFT" ] }, "userId":{ "type":"integer", "description":"The user who changed the status of the record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetItem":{ "title":"ApiEntityBudgetItem", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "budgetItemCost":{ "description":"Contains Budget Item cost related fields.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetItemCost" } ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "itemSuffix":{ "type":"integer", "description":"The suffix of a budget item code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the project budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The cost category assigned to this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "unitsOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project associated with this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "abbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of budget item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The type of cost associated with the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The unique identifier of the CBS Code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetChangeId":{ "type":"integer", "description":"Indicates whether the budget item originated in a budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier of a budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget item.", "format":"double", "exampleSetFlag":false }, "budgetHours":{ "type":"number", "description":"The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget item.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItemConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetItemConfiguredFieldValue":{ "title":"ApiEntityBudgetItemConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "budgetItemConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Budget Item Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier for an Budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetItemCost":{ "title":"ApiEntityBudgetItemCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "originalCostProject":{ "type":"number", "description":"The original cost of the budget line item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "originalCost":{ "minimum":0, "type":"number", "description":"The original cost of the budget line item. This value is based on the base currency.", "format":"double", "exampleSetFlag":false }, "originalCostWorkspace1":{ "type":"number", "description":"The original cost of the budget line item. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "originalCostWorkspace2":{ "type":"number", "description":"The original cost of the budget line item. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "originalCostWorkspace3":{ "type":"number", "description":"The original cost of the budget line item. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier of a budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitRate":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item. This value is based on the base currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace1":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace2":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace3":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "unitRateProject":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "laborRate":{ "type":"number", "description":"The cost per labor hour of the budget line item. This value is based on the base currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace1":{ "type":"number", "description":"The cost per labor hour of the budget line item. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace2":{ "type":"number", "description":"The cost per labor hour of the budget line item. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace3":{ "type":"number", "description":"The cost per labor hour of the budget line item. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "laborRateProject":{ "type":"number", "description":"The cost per labor hour of the budget line item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentCost":{ "type":"number", "description":"The current cost of the budget line item. This value is based on the base currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace1":{ "type":"number", "description":"The current cost of the budget line item. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace2":{ "type":"number", "description":"The current cost of the budget line item. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace3":{ "type":"number", "description":"The current cost of the budget line item. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentCostProject":{ "type":"number", "description":"The current cost of the budget line item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetItemConfiguredFieldValueInput":{ "title":"ApiEntityBudgetItemConfiguredFieldValueInput", "type":"object", "properties":{ "budgetItemConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Budget Item Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier for an Budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a BudgetItemConfiguredFieldValue object, a unique BudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                  • budgetItemConfiguredFieldValueId
                                                  • columnDefinitionId
                                                  • columnName
                                                  • columnLabel
                                                    • ", "exampleSetFlag":false }, "ApiEntityBudgetItemCostInput":{ "title":"ApiEntityBudgetItemCostInput", "required":[ "budgetItemId" ], "type":"object", "properties":{ "originalCostProject":{ "type":"number", "description":"The original cost of the budget line item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier of a budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitRateProject":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "laborRateProject":{ "type":"number", "description":"The cost per labor hour of the budget line item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityBudgetItemInput":{ "title":"ApiEntityBudgetItemInput", "required":[ "cbsSheetCodeId", "itemName", "projectId" ], "type":"object", "properties":{ "budgetItemCost":{ "description":"Contains Budget Item cost related fields.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetItemCostInput" } ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "budgetItemCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the project budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The cost category assigned to this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "unitsOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project associated with this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "abbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of budget item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The type of cost associated with the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The unique identifier of the CBS Code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier of a budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget item.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget item.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItemConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a BudgetItem object, a unique BudgetItem object can be identified by the following combinations of the fields.
                                                    • budgetItemId
                                                    • budgetItemCode,projectId
                                                    • budgetItemCode,projectCode,workspaceCode
                                                      • ", "exampleSetFlag":false }, "ApiEntityBudgetTransaction":{ "title":"ApiEntityBudgetTransaction", "type":"object", "properties":{ "budgetTransactionCost":{ "description":"The cost of a budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetTransactionCost" } ] }, "budgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a budget transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemCode":{ "maxLength":60, "type":"string", "description":"The system-generated unique identifier for the budget transaction item.", "exampleSetFlag":false, "types":[ "string" ] }, "changeMode":{ "type":"string", "description":"The detailed budget change line item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "AUTO", "MANUAL", "CHANGE" ] }, "desiredCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"A unique identifier for the budget item (Add Budget Line).", "exampleSetFlag":false, "types":[ "string" ] }, "budgetChangeId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemCodeSuffix":{ "type":"integer", "description":"The suffix of a budget transaction code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transactionType":{ "type":"string", "description":"Specifies whether the budget row is an original, change, or transfer value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CHANGE", "TRANSFER" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemName":{ "maxLength":255, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "budgetHours":{ "type":"number", "description":"The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.", "format":"double", "exampleSetFlag":false }, "budgetCbsSheetCodeId":{ "type":"integer", "description":"The name of the CBS Code associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetCostCategoryId":{ "type":"integer", "description":"The cost category ID of the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"The date the transaction was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget transfer transaction.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "action":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "crossEntityBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a project budget transfer of an object to which the project budget item is added in a destination transaction of a cross entity transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityTransferFromId":{ "type":"integer", "description":"The system-generated identifier of a budget item added in a cross object transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a program to project Project Budget Transfer, the program budget item ID has to be given in a destination transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a source budget transaction which has cross entity budget item involved.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToCostCategoryId":{ "type":"integer", "description":"The cost category ID of the source budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferFromCostCategoryId":{ "type":"integer", "description":"The cost category ID of the destination budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransferType":{ "type":"string", "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TO", "FROM" ] }, "transferFromCBSId":{ "type":"integer", "description":"The CBS code of the source budget line item. This identifies the CBS code of the budget line item you are transferring money from through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToCBSId":{ "type":"integer", "description":"The CBS code of the destination budget line item. This identifies the CBS code of the budget line item you are transferring money to through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToId":{ "type":"integer", "description":"The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferFromId":{ "type":"integer", "description":"The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransferId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedBudgetItem":{ "title":"ApiEntityExternallySourcedBudgetItem", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "budgetItemCost":{ "description":"Contains Budget Item cost related fields.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetItemCost" } ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "itemSuffix":{ "type":"integer", "description":"The suffix of a budget item code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the project budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The cost category assigned to this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "unitsOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project associated with this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "abbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of budget item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The type of cost associated with the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The unique identifier of the CBS Code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetChangeId":{ "type":"integer", "description":"Indicates whether the budget item originated in a budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier of a budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget item.", "format":"double", "exampleSetFlag":false }, "budgetHours":{ "type":"number", "description":"The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget item.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItemConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityERPSyncApiResponse":{ "title":"ApiEntityERPSyncApiResponse", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "primaryKeyName":{ "type":"string", "description":"The primary key field name associated with the integrated object.
                                                      The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "primaryKeyValue":{ "type":"integer", "description":"The unique identifier for the integrated object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of the object in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "message":{ "type":"string", "description":"Message is populated based on result of the operation.
                                                      Success - Message will not be populated. Please refer the statusCode.
                                                      Failure - Error message or reason for operation failure is populated.
                                                      Warning - warning message is populated.
                                                      The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "identifier":{ "type":"object", "description":"The unique identifier of the supported object returned based on the user input.
                                                      This field can return any of the following entities determined based on the object for which the API call is invoked.
                                                      Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.", "exampleSetFlag":false, "oneOf":[ { "$ref":"#/components/schemas/ProjectIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CBSSheetCodeIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ResourceIdentifier", "exampleSetFlag":false } ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "CBSSheetCodeIdentifier":{ "title":"CBSSheetCodeIdentifier", "type":"object", "properties":{ "costSheetId":{ "type":"integer", "description":"The unique identifier of a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The system-generated identifier of a parent cost item in a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsCode":{ "maxLength":60, "type":"string", "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ResourceIdentifier":{ "title":"ResourceIdentifier", "type":"object", "properties":{ "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedBudgetItemInput":{ "title":"ApiEntityExternallySourcedBudgetItemInput", "required":[ "cbsSheetCodeId", "itemName", "projectId" ], "type":"object", "properties":{ "budgetItemCost":{ "description":"Contains Budget Item cost related fields.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetItemCostInput" } ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "budgetItemCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the project budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The cost category assigned to this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "unitsOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project associated with this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "abbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of budget item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The type of cost associated with the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The unique identifier of the CBS Code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier of a budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget item.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget item.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetItemConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ExternallySourcedBudgetItem object, a unique ExternallySourcedBudgetItem object can be identified by the following combinations of the fields.
                                                      • budgetItemId
                                                      • budgetItemCode,projectId
                                                      • budgetItemCode,projectCode,workspaceCode
                                                        • ", "exampleSetFlag":false }, "ApiEntityScenarioStatus":{ "title":"ApiEntityScenarioStatus", "required":[ "portfolioId", "scenarioName" ], "type":"object", "properties":{ "portfolioId":{ "type":"integer", "description":"The system-generated identifier of the Capital Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated identifier of the Budget Plan Scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "maxLength":255, "type":"string", "description":"The name of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioStatus":{ "type":"string", "description":"The status of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ] }, "planPeriod":{ "type":"integer", "description":"The period during which budget is allocated to projects within the plan.
                                                        This value determines the year in which budget planning timescales start.
                                                        You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
                                                        After the planning period for a budget plan has been set it cannot be changed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ScenarioStatus object, a unique ScenarioStatus object can be identified by the following combinations of the fields.
                                                        • scenarioId
                                                        • scenarioName,planPeriod,portfolioId
                                                        • scenarioName,planPeriod,portfolioName,workspaceCode
                                                          • ", "exampleSetFlag":false }, "ApiEntityBudgetPlanProject":{ "title":"ApiEntityBudgetPlanProject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "planProjectSubCurveDetails":{ "type":"array", "description":"The capital and expense cost details of a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySubCostCurve", "exampleSetFlag":false }, "types":[ "array" ] }, "startDate":{ "type":"string", "description":"The start date of a plan project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The finish date of a plan project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "undistributed":{ "type":"number", "description":"The amount of budget currently unallocated across the project timescale.", "format":"double", "exampleSetFlag":false }, "distributed":{ "type":"number", "description":"The amount of budget currently allocated across the project timescale.", "format":"double", "exampleSetFlag":false }, "planProjectPeriods":{ "type":"array", "description":"The period budgets associated with a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial", "exampleSetFlag":false }, "types":[ "array" ] }, "costCurves":{ "type":"array", "description":"The phase costs associated with a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCostCurve", "exampleSetFlag":false }, "types":[ "array" ] }, "undistributedWorkspace1":{ "type":"number", "description":"The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "undistributedWorkspace2":{ "type":"number", "description":"The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "undistributedWorkspace3":{ "type":"number", "description":"The amount of budget currently unallocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "distributedWorkspace1":{ "type":"number", "description":"The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "distributedWorkspace2":{ "type":"number", "description":"The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "distributedWorkspace3":{ "type":"number", "description":"The amount of budget currently allocated across the project timescale based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace1":{ "type":"number", "description":"The total amount of budget for the project based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace2":{ "type":"number", "description":"The total amount of budget for the project based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace3":{ "type":"number", "description":"The total amount of budget for the project based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "total":{ "type":"number", "description":"The total amount of budget for the project based on base currency.", "format":"double", "exampleSetFlag":false }, "state":{ "type":"string", "description":"The state of capital plan project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The name of a plan project associated with a scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"The description of a plan project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectStatus":{ "type":"string", "description":"The budget review status of a plan project associated with a scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "ACCEPTED", "CHANGES_REQUESTED" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linked":{ "type":"boolean", "description":"The flag to link or unlink a project in a scenario.", "exampleSetFlag":false, "types":[ "boolean" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetPlanningScenario":{ "title":"ApiEntityBudgetPlanningScenario", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "targetBudgetUnDistributed":{ "type":"number", "description":"The amount of target budget unallocated to projects included in the portfolio's budget plan.", "format":"double", "exampleSetFlag":false }, "proposedBudgetDistributed":{ "type":"number", "description":"The amount of proposed budget currently allocated to projects included in the portfolio's budget plan.", "format":"double", "exampleSetFlag":false }, "proposedBudgetUnDistributed":{ "type":"number", "description":"The amount of a proposed budget unallocated to projects included in the portfolio's budget plan.", "format":"double", "exampleSetFlag":false }, "targetBudgetDistributedWorkspace1":{ "type":"number", "description":"The amount of target budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "targetBudgetDistributedWorkspace2":{ "type":"number", "description":"The amount of target budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "targetBudgetDistributedWorkspace3":{ "type":"number", "description":"The amount of target budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "targetBudgetUnDistributedWorkspace1":{ "type":"number", "description":"The amount of target budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "targetBudgetUnDistributedWorkspace2":{ "type":"number", "description":"The amount of target budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "targetBudgetUnDistributedWorkspace3":{ "type":"number", "description":"The amount of target budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetDistributedWorkspace1":{ "type":"number", "description":"The amount of proposed budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetDistributedWorkspace2":{ "type":"number", "description":"The amount of proposed budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetDistributedWorkspace3":{ "type":"number", "description":"The amount of proposed budget currently allocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetUnDistributedWorkspace1":{ "type":"number", "description":"The amount of a proposed budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetUnDistributedWorkspace2":{ "type":"number", "description":"The amount of a proposed budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetUnDistributedWorkspace3":{ "type":"number", "description":"The amount of a proposed budget unallocated to projects included in the portfolio's budget plan. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetWorkspace1":{ "type":"number", "description":"The total Proposed Budget for the portfolio as allocated by the budget planner.
                                                          Planners can plan proposed budgets in a bottom-up or top-down style.
                                                          Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values.
                                                          Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning.
                                                          Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning.
                                                          Becomes the portfolio's Current Approved Budget after the budget scenario is approved. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetWorkspace2":{ "type":"number", "description":"The total Proposed Budget for the portfolio as allocated by the budget planner.
                                                          Planners can plan proposed budgets in a bottom-up or top-down style.
                                                          Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values.
                                                          Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning.
                                                          Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning.
                                                          Becomes the portfolio's Current Approved Budget after the budget scenario is approved. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetWorkspace3":{ "type":"number", "description":"The total Proposed Budget for the portfolio as allocated by the budget planner.
                                                          Planners can plan proposed budgets in a bottom-up or top-down style.
                                                          Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values.
                                                          Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning.
                                                          Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning.
                                                          Becomes the portfolio's Current Approved Budget after the budget scenario is approved. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "targetBudget":{ "type":"number", "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on base currency.", "format":"double", "exampleSetFlag":false }, "targetBudgetWorkspace1":{ "type":"number", "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "targetBudgetWorkspace2":{ "type":"number", "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "targetBudgetWorkspace3":{ "type":"number", "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "targetBudgetDistributed":{ "type":"number", "description":"The amount of target budget currently allocated to projects included in the portfolio's budget plan.", "format":"double", "exampleSetFlag":false }, "proposedBudgetStart":{ "type":"string", "description":"The start date of proposed budget.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedBudgetFinish":{ "type":"string", "description":"The finish date of proposed budget.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedBudgetPeriods":{ "type":"array", "description":"The phase costs of proposed budget.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial", "exampleSetFlag":false }, "types":[ "array" ] }, "targetBudgetPeriods":{ "type":"array", "description":"The phase costs of target budget.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial", "exampleSetFlag":false }, "types":[ "array" ] }, "proposedSubCurveDetails":{ "type":"array", "description":"The proposed capital and expense cost details of a scenario.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySubCostCurve", "exampleSetFlag":false }, "types":[ "array" ] }, "targetSubCurveDetails":{ "type":"array", "description":"The target capital and expense cost details of a scenario.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySubCostCurve", "exampleSetFlag":false }, "types":[ "array" ] }, "proposedBudget":{ "type":"number", "description":"The total Proposed Budget for the portfolio as allocated by the budget planner.
                                                          Planners can plan proposed budgets in a bottom-up or top-down style.
                                                          Not all projects in the portfolio need to have Planned Budgets for planners to begin planning and setting proposed budget values.
                                                          Instead, by setting an overall plan Proposed Budget and allocating out its funds to included projects, planners can achieve top-down budget planning.
                                                          Similarly, project Planned Budgets and Forecast values can be linked to the Proposed Budget of a budget plan, allowing planners to establish project manager's budgets as a basis for their planning.
                                                          Becomes the portfolio's Current Approved Budget after the budget scenario is approved.", "format":"double", "exampleSetFlag":false }, "planProjects":{ "type":"array", "description":"The plan projects associated with a scenario.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanProject", "exampleSetFlag":false }, "types":[ "array" ] }, "portfolioName":{ "maxLength":255, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated identifier of the Budget Plan Scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "maxLength":255, "type":"string", "description":"The name of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "planPeriod":{ "type":"integer", "description":"The period during which budget is allocated to projects within the plan.
                                                          This value determines the year in which budget planning timescales start.
                                                          You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
                                                          After the planning period for a budget plan has been set it cannot be changed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of the Capital Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "hidden":{ "type":"boolean", "description":"Enables you to decide whether or not a scenario is hidden from other users.", "exampleSetFlag":false, "types":[ "boolean" ] }, "owner":{ "maxLength":255, "type":"string", "description":"The owner of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioStatus":{ "type":"string", "description":"The status of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ] }, "capitalPlanId":{ "type":"integer", "description":"The system-generated identifier of the Capital Plan.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPlanStatus":{ "type":"string", "description":"The current budget status of a portfolio. The status is set based on the status of the scenarios and cannot be edited manually.
                                                          In Planning: The portfolio is currently going through the budget planning process and contains one or more scenarios in planning. In planning is the default budget status.
                                                          Revising: The portfolio currently has one scenario with a status of approved, and another with a status of Under Review, Shared, or Under Approval.
                                                          Approved: The portfolio contains a scenario that has gone through the approval process and has been approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IN_PLANNING", "CLOSED", "APPROVED", "REVISING" ] }, "planProjectLinkType":{ "type":"string", "description":"Determines if linked projects in the portfolio budget plan link to project Forecast or Planned Budget.
                                                          Linked values will be factored into a budget plan's Proposed Budget.
                                                          Planners can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans.
                                                          Any budget plan added to a portfolio will inherit the value of its Proposed Budget Link Setting by default.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FORECAST", "PLANNED_BUDGET" ] }, "scenarioDescription":{ "maxLength":4000, "type":"string", "description":"The detailed summary for the plan.
                                                          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.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCount":{ "type":"integer", "description":"The total number of projects included in a portfolio budget plan.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "createdBy":{ "maxLength":255, "type":"string", "description":"The scenario created username.", "exampleSetFlag":false, "types":[ "string" ] }, "lastRefreshDate":{ "type":"string", "description":"The date a refresh was last performed on the portfolio budget plan scenario.", "format":"date-time", "exampleSetFlag":false }, "breakdownEnabled":{ "type":"boolean", "description":"The setting to convey whether Capital and Expense is enabled for a portfolio.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownType":{ "type":"string", "description":"The sub-cost curve to which the existing portfolio cost data will be mapped.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE" ] }, "createDate":{ "type":"string", "description":"The created date of the Budget Plan Scenario .", "format":"date-time", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCostCurve":{ "title":"ApiEntityCostCurve", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "costCurveType":{ "maxLength":255, "type":"string", "description":"The type of the cost curve.", "exampleSetFlag":false, "types":[ "string" ] }, "costCurvePeriods":{ "type":"array", "description":"The phase wise costs of cost curve.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial", "exampleSetFlag":false }, "types":[ "array" ] }, "startDate":{ "type":"string", "description":"The start date of the cost curve.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The finish date of the cost curve.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "undistributed":{ "type":"number", "description":"The undistributed cost of the cost curve.", "format":"double", "exampleSetFlag":false }, "distributed":{ "type":"number", "description":"The distributed cost of the cost curve.", "format":"double", "exampleSetFlag":false }, "undistributedWorkspace1":{ "type":"number", "description":"The undistributed cost of the cost curve. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "undistributedWorkspace2":{ "type":"number", "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "undistributedWorkspace3":{ "type":"number", "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "distributedWorkspace1":{ "type":"number", "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "distributedWorkspace2":{ "type":"number", "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "distributedWorkspace3":{ "type":"number", "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace1":{ "type":"number", "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace2":{ "type":"number", "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace3":{ "type":"number", "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "total":{ "type":"number", "description":"The total cost of the cost curve based on base currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScenarioPhaseFinancial":{ "title":"ApiEntityScenarioPhaseFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "year":{ "type":"integer", "description":"The year of phase period of a target or proposed budget.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "month":{ "type":"integer", "description":"The month of phase period of a target or proposed budget.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "phaseCost":{ "type":"number", "description":"The amount of a target or proposed budget for a particular period based on base currency.", "format":"double", "exampleSetFlag":false }, "phaseCostWorkspace1":{ "type":"number", "description":"The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "phaseCostWorkspace2":{ "type":"number", "description":"The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "phaseCostWorkspace3":{ "type":"number", "description":"The amount of a target or proposed budget for a particular period based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntitySubCostCurve":{ "title":"ApiEntitySubCostCurve", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "costSubCurveType":{ "type":"string", "description":"The type of the cost curve.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE" ] }, "costCurvePeriods":{ "type":"array", "description":"The phase wise costs of cost curve.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancial", "exampleSetFlag":false }, "types":[ "array" ] }, "undistributed":{ "type":"number", "description":"The undistributed cost of the cost curve.", "format":"double", "exampleSetFlag":false }, "distributed":{ "type":"number", "description":"The distributed cost of the cost curve.", "format":"double", "exampleSetFlag":false }, "undistributedWorkspace1":{ "type":"number", "description":"The undistributed cost of the cost curve. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "undistributedWorkspace2":{ "type":"number", "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "undistributedWorkspace3":{ "type":"number", "description":"The undistributed cost of the cost curve. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "distributedWorkspace1":{ "type":"number", "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "distributedWorkspace2":{ "type":"number", "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "distributedWorkspace3":{ "type":"number", "description":"The distributed cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace1":{ "type":"number", "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace2":{ "type":"number", "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace3":{ "type":"number", "description":"The total cost of the cost curve based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "total":{ "type":"number", "description":"The total cost of the cost curve based on base currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetPlanProjectInput":{ "title":"ApiEntityBudgetPlanProjectInput", "type":"object", "properties":{ "planProjectSubCurveDetails":{ "type":"array", "description":"The capital and expense cost details of a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySubCostCurveInput", "exampleSetFlag":false }, "types":[ "array" ] }, "totalCOR":{ "type":"number", "description":"The total amount of budget for the project. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "startDate":{ "type":"string", "description":"The start date of a plan project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The finish date of a plan project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planProjectPeriods":{ "type":"array", "description":"The period budgets associated with a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput", "exampleSetFlag":false }, "types":[ "array" ] }, "state":{ "type":"string", "description":"The state of capital plan project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The name of a plan project associated with a scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linked":{ "type":"boolean", "description":"The flag to link or unlink a project in a scenario.", "exampleSetFlag":false, "types":[ "boolean" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetPlanningScenarioInput":{ "title":"ApiEntityBudgetPlanningScenarioInput", "required":[ "planPeriod", "portfolioId", "scenarioName" ], "type":"object", "properties":{ "targetBudgetCOR":{ "type":"number", "description":"The total Target Budget for the portfolio's Planning Horizon set by the portfolio manager. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "targetBudgetPeriods":{ "type":"array", "description":"The phase costs of target budget.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput", "exampleSetFlag":false }, "types":[ "array" ] }, "targetSubCurveDetails":{ "type":"array", "description":"The target capital and expense cost details of a scenario.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySubCostCurveInput", "exampleSetFlag":false }, "types":[ "array" ] }, "planProjects":{ "type":"array", "description":"The plan projects associated with a scenario.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetPlanProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "portfolioName":{ "maxLength":255, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated identifier of the Budget Plan Scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "maxLength":255, "type":"string", "description":"The name of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "planPeriod":{ "type":"integer", "description":"The period during which budget is allocated to projects within the plan.
                                                          This value determines the year in which budget planning timescales start.
                                                          You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
                                                          After the planning period for a budget plan has been set it cannot be changed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of the Capital Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "hidden":{ "type":"boolean", "description":"Enables you to decide whether or not a scenario is hidden from other users.", "exampleSetFlag":false, "types":[ "boolean" ] }, "scenarioStatus":{ "type":"string", "description":"The status of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ] }, "scenarioDescription":{ "maxLength":4000, "type":"string", "description":"The detailed summary for the plan.
                                                          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.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a BudgetPlanningScenario object, a unique BudgetPlanningScenario object can be identified by the following combinations of the fields.
                                                          • scenarioId
                                                          • scenarioName,planPeriod,portfolioId
                                                          • scenarioName,planPeriod,portfolioName,workspaceCode
                                                            • ", "exampleSetFlag":false }, "ApiEntityScenarioPhaseFinancialInput":{ "title":"ApiEntityScenarioPhaseFinancialInput", "type":"object", "properties":{ "year":{ "type":"integer", "description":"The year of phase period of a target or proposed budget.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "month":{ "type":"integer", "description":"The month of phase period of a target or proposed budget.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "phaseCostCOR":{ "type":"number", "description":"The amount of a target or proposed budget for a particular period. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntitySubCostCurveInput":{ "title":"ApiEntitySubCostCurveInput", "type":"object", "properties":{ "costSubCurveType":{ "type":"string", "description":"The type of the cost curve.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE" ] }, "totalCOR":{ "type":"number", "description":"The total cost of the cost curve.", "format":"double", "exampleSetFlag":false }, "costCurvePeriods":{ "type":"array", "description":"The phase wise costs of cost curve.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScenarioPhaseFinancialInput", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityFundPeriod":{ "title":"ApiEntityFundPeriod", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "year":{ "type":"integer", "description":"The year of phase period of a fund.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "proposedFundCostWorkspace1":{ "type":"number", "description":"The cost of portfolio project fund based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundCostWorkspace2":{ "type":"number", "description":"The cost of portfolio project fund based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundCostWorkspace3":{ "type":"number", "description":"The cost of portfolio project fund based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundCost":{ "type":"number", "description":"The cost of portfolio project fund based on base currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundPlanProject":{ "title":"ApiEntityFundPlanProject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "remaining":{ "type":"number", "description":"The total portion of the funds that has not been consumed.", "format":"double", "exampleSetFlag":false }, "portfolioProjectFundPeriods":{ "type":"array", "description":"The phase funds associated with a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "proposedFundUndistributed":{ "type":"number", "description":"The proposed undistributed amount of a plan project.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace1":{ "type":"number", "description":"The total portion of the funds that has not been committed to actual work based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace2":{ "type":"number", "description":"The total portion of the funds that has not been committed to actual work based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace3":{ "type":"number", "description":"The total portion of the funds that has not been committed to actual work based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundUndistributedWorkspace1":{ "type":"number", "description":"The proposed undistributed amount of a plan project based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundUndistributedWorkspace2":{ "type":"number", "description":"The proposed undistributed amount of a plan project based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundUndistributedWorkspace3":{ "type":"number", "description":"The proposed undistributed amount of a plan project based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundTotalWorkspace1":{ "type":"number", "description":"The proposed fund total of a plan project based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundTotalWorkspace2":{ "type":"number", "description":"The proposed fund total of a plan project based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundTotalWorkspace3":{ "type":"number", "description":"The proposed fund total of a plan project based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributedWorkspace1":{ "type":"number", "description":"The proposed distributed amount of a plan project based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributedWorkspace2":{ "type":"number", "description":"The proposed distributed amount of a plan project based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributedWorkspace3":{ "type":"number", "description":"The proposed distributed amount of a plan project based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "totalFund":{ "type":"number", "description":"The total fund of a plan project.", "format":"double", "exampleSetFlag":false }, "totalFundWorkspace1":{ "type":"number", "description":"The total fund of a plan project based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalFundWorkspace2":{ "type":"number", "description":"The total fund of a plan project based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalFundWorkspace3":{ "type":"number", "description":"The total fund of a plan project based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "portfolioProjectFunds":{ "type":"array", "description":"The funds assigned to a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioProjectFund", "exampleSetFlag":false }, "types":[ "array" ] }, "appropriated":{ "type":"number", "description":"The total portion of the funds that has been committed to work on projects.", "format":"double", "exampleSetFlag":false }, "unappropriated":{ "type":"number", "description":"The total portion of the funds that has not been committed to actual work.", "format":"double", "exampleSetFlag":false }, "consumed":{ "type":"number", "description":"The total portion of the funds that has been spent to complete work on projects.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace1":{ "type":"number", "description":"The total portion of the funds that has been committed to work on projects based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace2":{ "type":"number", "description":"The total portion of the funds that has been committed to work on projects based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace3":{ "type":"number", "description":"The total portion of the funds that has been committed to work on projects based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace1":{ "type":"number", "description":"The total portion of the funds that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace2":{ "type":"number", "description":"The total portion of the funds that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace3":{ "type":"number", "description":"The total portion of the funds that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace1":{ "type":"number", "description":"The total portion of the funds that has not been consumed based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace2":{ "type":"number", "description":"The total portion of the funds that has not been consumed based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace3":{ "type":"number", "description":"The total portion of the funds that has not been consumed based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundTotal":{ "type":"number", "description":"The proposed fund total of a plan project.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributed":{ "type":"number", "description":"The proposed distributed amount of a plan project.", "format":"double", "exampleSetFlag":false }, "proposedFundStart":{ "type":"string", "description":"The start date of proposed fund of a project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedFundFinish":{ "type":"string", "description":"The finish date of proposed fund of a project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "state":{ "type":"string", "description":"The state of capital plan project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The name of a plan project associated with a scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"The description of a plan project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectStatus":{ "type":"string", "description":"The budget review status of a plan project associated with a scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "ACCEPTED", "CHANGES_REQUESTED" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linked":{ "type":"boolean", "description":"The flag to link or unlink a project in a scenario.", "exampleSetFlag":false, "types":[ "boolean" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundPlanningScenario":{ "title":"ApiEntityFundPlanningScenario", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "proposedFundUnDistributed":{ "type":"number", "description":"The undistributed proposed fund of all the plan projects.", "format":"double", "exampleSetFlag":false }, "proposedFundTotalWorkspace1":{ "type":"number", "description":"The total proposed fund of all the plan projects based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundTotalWorkspace2":{ "type":"number", "description":"The total proposed fund of all the plan projects based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundTotalWorkspace3":{ "type":"number", "description":"The total proposed fund of all the plan projects based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundUnDistributedWorkspace1":{ "type":"number", "description":"The undistributed proposed fund of all the plan projects based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundUnDistributedWorkspace2":{ "type":"number", "description":"The undistributed proposed fund of all the plan projects based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundUnDistributedWorkspace3":{ "type":"number", "description":"The undistributed proposed fund of all the plan projects based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributedWorkspace1":{ "type":"number", "description":"The proposed distributed amount of plan projects based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributedWorkspace2":{ "type":"number", "description":"The proposed distributed amount of plan projects based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributedWorkspace3":{ "type":"number", "description":"The proposed distributed amount of plan projects based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundTotal":{ "type":"number", "description":"The total proposed fund of all the plan projects.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributed":{ "type":"number", "description":"The proposed distributed amount of plan projects.", "format":"double", "exampleSetFlag":false }, "proposedFundPeriods":{ "type":"array", "description":"The phase funds of the proposed fund of all the plan projects.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "proposedFundStart":{ "type":"string", "description":"The start date of proposed fund of a scenario.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedFundFinish":{ "type":"string", "description":"The finish date of proposed fund of a scenario.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planProjects":{ "type":"array", "description":"The plan projects associated with a scenario.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPlanProject", "exampleSetFlag":false }, "types":[ "array" ] }, "hidden":{ "type":"boolean", "description":"Enables you to decide whether or not a scenario is hidden from other users.", "exampleSetFlag":false, "types":[ "boolean" ] }, "owner":{ "maxLength":255, "type":"string", "description":"The owner of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of the Capital Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated identifier of the Budget Plan Scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "maxLength":255, "type":"string", "description":"The name of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioStatus":{ "type":"string", "description":"The status of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ] }, "capitalPlanId":{ "type":"integer", "description":"The system-generated identifier of the Capital Plan.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "planPeriod":{ "type":"integer", "description":"The period during which budget is allocated to projects within the plan.
                                                            This value determines the year in which budget planning timescales start.
                                                            You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
                                                            After the planning period for a budget plan has been set it cannot be changed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPlanStatus":{ "type":"string", "description":"The current budget status of a portfolio. The status is set based on the status of the scenarios and cannot be edited manually.
                                                            In Planning: The portfolio is currently going through the budget planning process and contains one or more scenarios in planning. In planning is the default budget status.
                                                            Revising: The portfolio currently has one scenario with a status of approved, and another with a status of Under Review, Shared, or Under Approval.
                                                            Approved: The portfolio contains a scenario that has gone through the approval process and has been approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IN_PLANNING", "CLOSED", "APPROVED", "REVISING" ] }, "planProjectLinkType":{ "type":"string", "description":"Determines if linked projects in the portfolio budget plan link to project Forecast or Planned Budget.
                                                            Linked values will be factored into a budget plan's Proposed Budget.
                                                            Planners can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans.
                                                            Any budget plan added to a portfolio will inherit the value of its Proposed Budget Link Setting by default.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FORECAST", "PLANNED_BUDGET" ] }, "scenarioDescription":{ "maxLength":4000, "type":"string", "description":"The detailed summary for the plan.
                                                            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.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCount":{ "type":"integer", "description":"The total number of projects included in a portfolio budget plan.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "createdBy":{ "maxLength":255, "type":"string", "description":"The scenario created username.", "exampleSetFlag":false, "types":[ "string" ] }, "lastRefreshDate":{ "type":"string", "description":"The date a refresh was last performed on the portfolio budget plan scenario.", "format":"date-time", "exampleSetFlag":false }, "breakdownEnabled":{ "type":"boolean", "description":"The setting to convey whether Capital and Expense is enabled for a portfolio.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownType":{ "type":"string", "description":"The sub-cost curve to which the existing portfolio cost data will be mapped.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE" ] }, "createDate":{ "type":"string", "description":"The created date of the Budget Plan Scenario .", "format":"date-time", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioProjectFund":{ "title":"ApiEntityPortfolioProjectFund", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "remaining":{ "type":"number", "description":"The portion of the fund that has not been consumed.", "format":"double", "exampleSetFlag":false }, "proposedFundUndistributed":{ "type":"number", "description":"The amount of money that has not been distributed for the fund.", "format":"double", "exampleSetFlag":false }, "fundAssignUnAssignAction":{ "type":"string", "description":"The action to be taken for a fund associated with a plan project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ASSIGN", "UNASSIGN" ] }, "unappropriatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundUndistributedWorkspace1":{ "type":"number", "description":"The amount of money that has not been distributed for the fund based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundUndistributedWorkspace2":{ "type":"number", "description":"The amount of money that has not been distributed for the fund based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundUndistributedWorkspace3":{ "type":"number", "description":"The amount of money that has not been distributed for the fund based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributedWorkspace1":{ "type":"number", "description":"The amount of money that has been distributed for the fund based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributedWorkspace2":{ "type":"number", "description":"The amount of money that has been distributed for the fund based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributedWorkspace3":{ "type":"number", "description":"The amount of money that has been distributed for the fund based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "fundName":{ "maxLength":255, "type":"string", "description":"The name of a fund associated with a plan project.", "exampleSetFlag":false, "types":[ "string" ] }, "fundCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a fund associated with a plan project.", "exampleSetFlag":false, "types":[ "string" ] }, "fundStatus":{ "type":"string", "description":"The status of a fund associated with a plan project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "fundStartDate":{ "type":"string", "description":"The date when money in the fund will start being available.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "fundEndDate":{ "type":"string", "description":"The date when money in the fund will no longer be available.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedFund":{ "type":"number", "description":"The proposed fund of a fund associated with a plan project based on base currency.", "format":"double", "exampleSetFlag":false }, "appropriated":{ "type":"number", "description":"The portion of the fund that has been committed to work on projects.", "format":"double", "exampleSetFlag":false }, "unappropriated":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work.", "format":"double", "exampleSetFlag":false }, "consumed":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects.", "format":"double", "exampleSetFlag":false }, "allocated":{ "type":"number", "description":"The portion of the fund that has been distributed to projects.", "format":"double", "exampleSetFlag":false }, "proposedFundWorkspace1":{ "type":"number", "description":"The proposed fund of a fund associated with a plan project based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundWorkspace2":{ "type":"number", "description":"The proposed fund of a fund associated with a plan project based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundWorkspace3":{ "type":"number", "description":"The proposed fund of a fund associated with a plan project based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has been committed to work on projects based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has been committed to work on projects based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has been committed to work on projects based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace1":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace2":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace3":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace1":{ "type":"number", "description":"The portion of the fund that has not been consumed based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace2":{ "type":"number", "description":"The portion of the fund that has not been consumed based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace3":{ "type":"number", "description":"The portion of the fund that has not been consumed based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has been distributed to projects based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has been distributed to projects based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has been distributed to projects based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace1":{ "type":"number", "description":"The amount of money granted for the fund based on the workspace currency. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace2":{ "type":"number", "description":"The amount of money granted for the fund based on the workspace currency. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace3":{ "type":"number", "description":"The amount of money granted for the fund based on the workspace currency. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedFundDistributed":{ "type":"number", "description":"The amount of money that has been distributed for the fund.", "format":"double", "exampleSetFlag":false }, "fundId":{ "type":"integer", "description":"The unique identifier of a fund associated with a plan project. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "total":{ "type":"number", "description":"The amount of money granted for the fund.", "format":"double", "exampleSetFlag":false }, "periods":{ "type":"array", "description":"The phase wise fund associated with a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundPeriodInput":{ "title":"ApiEntityFundPeriodInput", "type":"object", "properties":{ "year":{ "type":"integer", "description":"The year of phase period of a fund.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "proposedFundCostCOR":{ "type":"number", "description":"The cost of portfolio project fund. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityFundPlanProjectInput":{ "title":"ApiEntityFundPlanProjectInput", "type":"object", "properties":{ "portfolioProjectFunds":{ "type":"array", "description":"The funds assigned to a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioProjectFundInput", "exampleSetFlag":false }, "types":[ "array" ] }, "state":{ "type":"string", "description":"The state of capital plan project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The name of a plan project associated with a scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linked":{ "type":"boolean", "description":"The flag to link or unlink a project in a scenario.", "exampleSetFlag":false, "types":[ "boolean" ] } }, "exampleSetFlag":false }, "ApiEntityFundPlanningScenarioInput":{ "title":"ApiEntityFundPlanningScenarioInput", "required":[ "planPeriod", "portfolioId", "scenarioName" ], "type":"object", "properties":{ "planProjects":{ "type":"array", "description":"The plan projects associated with a scenario.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPlanProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "hidden":{ "type":"boolean", "description":"Enables you to decide whether or not a scenario is hidden from other users.", "exampleSetFlag":false, "types":[ "boolean" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of the Capital Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated identifier of the Budget Plan Scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "maxLength":255, "type":"string", "description":"The name of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioStatus":{ "type":"string", "description":"The status of Budget Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ] }, "planPeriod":{ "type":"integer", "description":"The period during which budget is allocated to projects within the plan.
                                                            This value determines the year in which budget planning timescales start.
                                                            You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
                                                            After the planning period for a budget plan has been set it cannot be changed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioDescription":{ "maxLength":4000, "type":"string", "description":"The detailed summary for the plan.
                                                            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.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioProjectFundInput":{ "title":"ApiEntityPortfolioProjectFundInput", "type":"object", "properties":{ "fundAssignUnAssignAction":{ "type":"string", "description":"The action to be taken for a fund associated with a plan project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ASSIGN", "UNASSIGN" ] }, "proposedFundCOR":{ "type":"number", "description":"The proposed fund of a fund associated with a plan project based on base currency.", "format":"double", "exampleSetFlag":false }, "fundName":{ "maxLength":255, "type":"string", "description":"The name of a fund associated with a plan project.", "exampleSetFlag":false, "types":[ "string" ] }, "fundCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a fund associated with a plan project.", "exampleSetFlag":false, "types":[ "string" ] }, "fundStartDate":{ "type":"string", "description":"The date when money in the fund will start being available.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "fundEndDate":{ "type":"string", "description":"The date when money in the fund will no longer be available.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "fundId":{ "type":"integer", "description":"The unique identifier of a fund associated with a plan project. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periods":{ "type":"array", "description":"The phase wise fund associated with a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundPeriodInput", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetTransfer":{ "title":"ApiEntityBudgetTransfer", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "withdrawApprovalByUserId":{ "type":"integer", "description":"The username of the user that with withdrew approval of the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "withdrawApprovalByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who withdrew a project budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information about the transaction.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransferCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the project budget transfer request.", "exampleSetFlag":false, "types":[ "string" ] }, "itemSuffix":{ "type":"integer", "description":"The suffix of a budget transfer code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemPrefix":{ "maxLength":60, "type":"string", "description":"The prefix of a budget transfer code.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a budget transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransactions":{ "type":"array", "description":"List of all budget transactions for the project budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "submitByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who submitted a project budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "submitDate":{ "type":"string", "description":"Date the item was submitted.", "format":"date-time", "exampleSetFlag":false }, "withdrawApprovalDate":{ "type":"string", "description":"Date the item was withdrawn.", "format":"date-time", "exampleSetFlag":false }, "approveByUserId":{ "type":"integer", "description":"The username of the user that approved the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who approved a project budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "lastModifiedById":{ "type":"integer", "description":"The username of the user who last made changes to the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserId":{ "type":"integer", "description":"The username of the user that rejected the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who rejected a project budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "rejectDate":{ "type":"string", "description":"Date the item was rejected.", "format":"date-time", "exampleSetFlag":false }, "submitByUserId":{ "type":"integer", "description":"The username of the user that submitted the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier of a budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"Date the item was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the project budget transfer request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetTransferConfiguredFieldValue":{ "title":"ApiEntityBudgetTransferConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransferConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Project Budget Transfer Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a budget transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetTransferTransaction":{ "title":"ApiEntityBudgetTransferTransaction", "type":"object", "properties":{ "crossEntityBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a project budget transfer of an object to which the project budget item is added in a destination transaction of a cross entity transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityTransferFromId":{ "type":"integer", "description":"The system-generated identifier of a budget item added in a cross object transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a program to project Project Budget Transfer, the program budget item ID has to be given in a destination transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a source budget transaction which has cross entity budget item involved.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToCostCategoryId":{ "type":"integer", "description":"The cost category ID of the source budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferFromCostCategoryId":{ "type":"integer", "description":"The cost category ID of the destination budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransactionCost":{ "description":"The cost of a budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetTransactionCost" } ] }, "budgetTransferType":{ "type":"string", "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TO", "FROM" ] }, "transferFromCBSId":{ "type":"integer", "description":"The CBS code of the source budget line item. This identifies the CBS code of the budget line item you are transferring money from through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToCBSId":{ "type":"integer", "description":"The CBS code of the destination budget line item. This identifies the CBS code of the budget line item you are transferring money to through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToId":{ "type":"integer", "description":"The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferFromId":{ "type":"integer", "description":"The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransferId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a budget transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemCode":{ "maxLength":60, "type":"string", "description":"The system-generated unique identifier for the budget transaction item.", "exampleSetFlag":false, "types":[ "string" ] }, "itemCodeSuffix":{ "type":"integer", "description":"The suffix of a budget transaction code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transactionType":{ "type":"string", "description":"Specifies whether the budget row is an original, change, or transfer value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CHANGE", "TRANSFER" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemName":{ "maxLength":255, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "budgetHours":{ "type":"number", "description":"The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.", "format":"double", "exampleSetFlag":false }, "budgetCbsSheetCodeId":{ "type":"integer", "description":"The name of the CBS Code associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetCostCategoryId":{ "type":"integer", "description":"The cost category ID of the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"The date the transaction was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget transfer transaction.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "action":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityBudgetTransferConfiguredFieldValueInput":{ "title":"ApiEntityBudgetTransferConfiguredFieldValueInput", "type":"object", "properties":{ "budgetTransferConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Project Budget Transfer Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a budget transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a BudgetTransferConfiguredFieldValue object, a unique BudgetTransferConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                            • budgetTransferConfiguredFieldValueId
                                                            • columnDefinitionId
                                                            • columnName
                                                            • columnLabel
                                                              • ", "exampleSetFlag":false }, "ApiEntityBudgetTransferInput":{ "title":"ApiEntityBudgetTransferInput", "required":[ "projectId" ], "type":"object", "properties":{ "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information about the transaction.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransferCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the project budget transfer request.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a budget transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransactions":{ "type":"array", "description":"List of all budget transactions for the project budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferTransactionInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier of a budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the project budget transfer request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] } }, "description":"This entity represents a BudgetTransfer object, a unique BudgetTransfer object can be identified by the following combinations of the fields.
                                                              • budgetTransferId
                                                              • budgetTransferCode,projectId
                                                              • budgetTransferCode,projectCode,workspaceCode
                                                              • budgetTransferCode,projectBudgetId
                                                                • ", "exampleSetFlag":false }, "ApiEntityBudgetTransferTransactionInput":{ "title":"ApiEntityBudgetTransferTransactionInput", "required":[ "transferFromId" ], "type":"object", "properties":{ "crossEntityBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a project budget transfer of an object to which the project budget item is added in a destination transaction of a cross entity transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityTransferFromId":{ "type":"integer", "description":"The system-generated identifier of a budget item added in a cross object transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a program to project Project Budget Transfer, the program budget item ID has to be given in a destination transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a source budget transaction which has cross entity budget item involved.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransactionCost":{ "description":"The cost of a budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBudgetTransactionCostInput" } ] }, "budgetTransferType":{ "type":"string", "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TO", "FROM" ] }, "transferToId":{ "type":"integer", "description":"The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferFromId":{ "type":"integer", "description":"The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransferId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a budget transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "itemCode":{ "maxLength":60, "type":"string", "description":"The system-generated unique identifier for the budget transaction item.", "exampleSetFlag":false, "types":[ "string" ] }, "transactionType":{ "type":"string", "description":"Specifies whether the budget row is an original, change, or transfer value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CHANGE", "TRANSFER" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a budget transfer transaction.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransactionConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a BudgetTransferTransaction object, a unique BudgetTransferTransaction object can be identified by the following combinations of the fields.
                                                                • budgetTransactionId
                                                                  • ", "exampleSetFlag":false }, "ApiEntityBudgetTransferStatusTransitionHistory":{ "title":"ApiEntityBudgetTransferStatusTransitionHistory", "required":[ "budgetTransferStatusTransitionHistoryId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Comments included by the user who changed the status of the record.", "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"The date the status of the record was changed.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransferStatusTransitionHistoryId":{ "type":"integer", "description":"The system-generated identifier of a budget transfer status transition history.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The name of the user associated with the status transition history.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a budget transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "statusTransitionType":{ "type":"string", "description":"The type of change made to the record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "REJECT", "DRAFT" ] }, "userId":{ "type":"integer", "description":"The user who changed the status of the record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSSheetCode":{ "title":"ApiEntityCBSSheetCode", "required":[ "cbsCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "copiedFromItem":{ "type":"integer", "description":"The unique identifier for the original ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "description":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the CBS code.", "exampleSetFlag":false, "types":[ "string" ] }, "parentCBSCodes":{ "type":"array", "description":"List of parent cbs codes in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "costSheetRow":{ "description":"A CBS sheet row object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSSheetRow" } ] }, "costSheetRowCost":{ "description":"The cost of a CBS sheet row.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSSheetRowCost" } ] }, "costSheetId":{ "type":"integer", "description":"The unique identifier of a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"Number that specifies the position of the cost sheet item.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The system-generated identifier of a parent cost item in a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of cost sheet item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isActive":{ "type":"boolean", "description":"The active field indicates whether the CBS code is active for use.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costType":{ "type":"string", "description":"The category of the cost breakdown structure code.
                                                                  Expense: Represents an expense.
                                                                  Capital: Represents capital.
                                                                  None: Type is not divided into expense or capital. None is selected by default if no other choice is made.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE", "NONE" ] }, "isTotalRow":{ "type":"boolean", "description":"Indicates this item represents the total cost of the project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSSheetRow":{ "title":"ApiEntityCBSSheetRow", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The CBS code assigned to the line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedHours":{ "type":"number", "description":"The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
                                                                  Calculated as Original Quantity multiplied by Original Productivity Rate.
                                                                  Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"Calculated as the sum of all pending hour changes in the change records for the scope assignment.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The sum of all approved change hours in the change and transfer records for the scope assignment.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "type":"number", "description":"Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "type":"number", "description":"The Revised Hours at the time the baseline was set.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "etcHours":{ "type":"number", "description":"The estimated number of hours needed to complete the work.
                                                                  Calculated as BAC Hours minus Earned Hours.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "eacHours":{ "type":"number", "description":"Calculated as ETC Hours plus Actual Hours to Date.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "earnedHours":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "etcAdjustedHours":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "actualHoursToDate":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "bacHours":{ "type":"number", "description":"The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "remainingHours":{ "type":"number", "description":"The number of hours left for the scope assignment.
                                                                  Calculated as Remaining Quantity multiplied by Revised Productivity Rate.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "installedHours":{ "type":"number", "description":"Hours spent on the scope assignment.
                                                                  Calculated as Installed Quantity multiplied by Revised Productivity Rate.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "atCompletionHours":{ "type":"number", "description":"The total hours expected for the scope assignment.
                                                                  Calculated as Revised Hours plus Adjusted Hours.
                                                                  This is the cumulative value for all objects in the project with the same CBS code.", "format":"double", "exampleSetFlag":false }, "projectHPI":{ "type":"number", "description":"Calculated as the total of Project Earned Hours divided by Project Actual Hours.", "format":"double", "exampleSetFlag":false }, "projectActualHours":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "projectEarnedHours":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetRowConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSSheetRowConfiguredFieldValue":{ "title":"ApiEntityCBSSheetRowConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "costSheetRowConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Project Cost Sheet Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costSheetRowId":{ "type":"integer", "description":"The system-generated identifier of a CBS Code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSSheetRowCost":{ "title":"ApiEntityCBSSheetRowCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "pendingProjectActualsWorkspace1":{ "type":"number", "description":"Total amount of pending actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "pendingProjectActualsWorkspace2":{ "type":"number", "description":"Total amount of pending actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "pendingProjectActualsWorkspace3":{ "type":"number", "description":"Total amount of pending actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "pendingProjectActualsProject":{ "type":"number", "description":"Total amount of pending actuals for a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedProjectActualsWorkspace1":{ "type":"number", "description":"The total amount of confirmed actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "approvedProjectActualsWorkspace2":{ "type":"number", "description":"The total amount of confirmed actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "approvedProjectActualsWorkspace3":{ "type":"number", "description":"The total amount of confirmed actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "approvedProjectActualsProject":{ "type":"number", "description":"The total amount of confirmed actuals for a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualRiskResponseProject":{ "type":"number", "description":"The pending manual budget of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualRiskResponseWorkspace1":{ "type":"number", "description":"The actual cost of implementing a response action for a workspace.", "format":"double", "exampleSetFlag":false }, "actualRiskResponseWorkspace2":{ "type":"number", "description":"The actual cost of implementing a response action for a workspace.", "format":"double", "exampleSetFlag":false }, "actualRiskResponseWorkspace3":{ "type":"number", "description":"The actual cost of implementing a response action for a workspace.", "format":"double", "exampleSetFlag":false }, "closedPostExposureProject":{ "type":"number", "description":"The mean post-response probability of a closed risk multiplied by the mean post-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "closedPostExposureWorkspace1":{ "type":"number", "description":"The mean post-response probability of a closed risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "closedPostExposureWorkspace2":{ "type":"number", "description":"The mean post-response probability of a closed risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "closedPostExposureWorkspace3":{ "type":"number", "description":"The mean post-response probability of a closed risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "closedPreExposureWorkspace1":{ "type":"number", "description":"The mean pre-response probability of a closed risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "closedPreExposureWorkspace2":{ "type":"number", "description":"The mean pre-response probability of a closed risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "closedPreExposureWorkspace3":{ "type":"number", "description":"The mean pre-response probability of a closed risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "closedPreExposureProject":{ "type":"number", "description":"The mean pre-response probability of a closed risk multiplied by the mean pre-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "openPostExposureWorkspace1":{ "type":"number", "description":"The mean post-response probability of an open risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPostExposureWorkspace2":{ "type":"number", "description":"The mean post-response probability of an open risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPostExposureWorkspace3":{ "type":"number", "description":"The mean post-response probability of an open risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPreExposureWorkspace1":{ "type":"number", "description":"The mean pre-response probability of an open risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPreExposureWorkspace2":{ "type":"number", "description":"The mean pre-response probability of an open risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPreExposureWorkspace3":{ "type":"number", "description":"The mean pre-response probability of an open risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponseProject":{ "type":"number", "description":"The actual cost of implementing a response action for a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponseWorkspace1":{ "type":"number", "description":"The estimated cost associated with implementing the response action for the workspace.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponseWorkspace2":{ "type":"number", "description":"The estimated cost associated with implementing the response action for the workspace.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponseWorkspace3":{ "type":"number", "description":"The estimated cost associated with implementing the response action for the workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetWorkspace3":{ "type":"number", "description":"The pending manual cost of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetProject":{ "type":"number", "description":"The pending manual cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetWorkspace1":{ "type":"number", "description":"Calculated as the sum of all costs approved for the manual budget.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetWorkspace2":{ "type":"number", "description":"Calculated as the sum of all costs approved for the manual budget.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetWorkspace3":{ "type":"number", "description":"Calculated as the sum of all costs approved for the manual budget.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetProject":{ "type":"number", "description":"Calculated as the sum of all costs approved for the manual budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChanges":{ "type":"number", "description":"Calculated as the sum of all pending manual budget changes for the project. This field is in base currency and is calculated from pendingManualBudgetChangesProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChangesWorkspace1":{ "type":"number", "description":"Pending manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChangesWorkspace2":{ "type":"number", "description":"Pending manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChangesWorkspace3":{ "type":"number", "description":"Pending manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChangesProject":{ "type":"number", "description":"Pending manual budget changes of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChanges":{ "type":"number", "description":"The total approved current manual budget of a project. Calculated as the sum of Approved Original Manual Budget plus Approved Manual Budget Changes plus Approved Manual Budget Transfers. This field is in base currency and is calculated from approvedManualBudgetChangesProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChangesWorkspace1":{ "type":"number", "description":"Approved manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChangesWorkspace2":{ "type":"number", "description":"Approved manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChangesWorkspace3":{ "type":"number", "description":"Approved manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChangesProject":{ "type":"number", "description":"Approved manual budget changes of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfers":{ "type":"number", "description":"Calculated as the sum of all pending manual budget transfers for the project. This field is in base currency and is calculated from pendingManualBudgetTransfersProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfersWorkspace1":{ "type":"number", "description":"Pending manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfersWorkspace2":{ "type":"number", "description":"Pending manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfersWorkspace3":{ "type":"number", "description":"Pending manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfersProject":{ "type":"number", "description":"Pending manual budget transfers of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfers":{ "type":"number", "description":"Calculated as the sum of all approved manual budget transfers for the project. This field is in base currency and is calculated from approvedManualBudgetTransfersProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfersWorkspace1":{ "type":"number", "description":"Approved manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfersWorkspace2":{ "type":"number", "description":"Approved manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfersWorkspace3":{ "type":"number", "description":"Approved manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfersProject":{ "type":"number", "description":"Approved manual budget transfers of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudget":{ "type":"number", "description":"The total approved current manual budget of a project. Calculated as the sum of Approved Original Manual Budget plus Approved Manual Budget Changes plus Approved Manual Budget Transfers. This field is in base currency and is calculated from approvedManualCurrentBudgetProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudgetWorkspace1":{ "type":"number", "description":"Approved manual current budget of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudgetWorkspace2":{ "type":"number", "description":"Approved manual current budget of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudgetWorkspace3":{ "type":"number", "description":"Approved manual current budget of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudgetProject":{ "type":"number", "description":"Approved manual current budget of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetWorkspace1":{ "type":"number", "description":"The pending manual budget of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetWorkspace2":{ "type":"number", "description":"The pending manual budget of a workspace.", "format":"double", "exampleSetFlag":false }, "projectActualCostProject":{ "type":"number", "description":"Calculated as the sum of the amount of each actual line item for a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "projectEarnedCostProject":{ "type":"number", "description":"The earned cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace1":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace2":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace3":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace1":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace2":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace3":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace1":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace2":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace3":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace1":{ "type":"number", "description":"The total cost at the completion of the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace2":{ "type":"number", "description":"The total cost at the completion of the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace3":{ "type":"number", "description":"The total cost at the completion of the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace1":{ "type":"number", "description":"Total costs accrued on a project within a given time period, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace2":{ "type":"number", "description":"Total costs accrued on a project within a given time period, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace3":{ "type":"number", "description":"Total costs accrued on a project within a given time period, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostProject":{ "type":"number", "description":"The pending changed cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostProject":{ "type":"number", "description":"The approved changed cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingProjectActuals":{ "type":"number", "description":"The total amount of pending actuals. This field is in base currency and is calculated from pendingProjectActualsProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedProjectActuals":{ "type":"number", "description":"The total amount of confirmed actuals. This field is in base currency and is calculated from approvedProjectActualsProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualRiskResponse":{ "type":"number", "description":"The actual cost of implementing the response action. This field is in base currency and is calculated from actualRiskResponseProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "closedPostExposure":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This field is in base currency and is calculated from closedPostExposureProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "closedPreExposure":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This field is in base currency and is calculated from closedPreExposureProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "openPostExposure":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This field is in base currency and is calculated from openPostExposureProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "openPostExposureProject":{ "type":"number", "description":"The mean post-response probability of an open risk multiplied by the mean post-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "openPreExposure":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This field is in base currency and is calculated from openPreExposureProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "openPreExposureProject":{ "type":"number", "description":"The mean pre-response probability of an open risk multiplied by the mean pre-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponse":{ "type":"number", "description":"The estimated cost associated with implementing the response action. This field is in base currency and is calculated from plannedRiskResponseProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace2":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace3":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace1":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace2":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace3":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace1":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace2":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace3":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace1":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace2":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace3":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace1":{ "type":"number", "description":"The amount left to be spent. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace2":{ "type":"number", "description":"The amount left to be spent. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace3":{ "type":"number", "description":"The amount left to be spent. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace1":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace2":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace3":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace1":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace2":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace3":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostProject":{ "type":"number", "description":"The planned cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "revisedCostProject":{ "type":"number", "description":"The revised cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "eacCostProject":{ "type":"number", "description":"The EAC cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "etcCostProject":{ "type":"number", "description":"The ETC cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "earnedCostProject":{ "type":"number", "description":"The earned cost of a project.", "format":"double", "exampleSetFlag":false }, "baselineCostProject":{ "type":"number", "description":"The baseline cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateProject":{ "type":"number", "description":"The actual cost to date of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "bacCostProject":{ "type":"number", "description":"The BAC cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"Calculated as the sum of actual costs plus remaining costs for the project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingCostProject":{ "type":"number", "description":"The remaining total cost for the project, including labor resources, nonlabor resources, and project expenses. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "installedCostProject":{ "type":"number", "description":"The installed cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostProject":{ "type":"number", "description":"The adjusted cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualBudget":{ "type":"number", "description":"Calculated as the sum of all costs approved for the original manual budget. This field is in base currency and is calculated from approvedManualBudgetProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingManualBudget":{ "type":"number", "description":"Calculated as the sum of all costs pending for the original manual budget. This field is in base currency and is calculated from pendingManualBudgetProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "projectCPIProject":{ "type":"number", "description":"The CPI cost of a project. This value is based on the project currency.", "exampleSetFlag":false, "types":[ "number" ] }, "currentBudgetProject":{ "type":"number", "description":"Calculated as the sum of all current costs for the selected budget sources. Selected budget sources can include scope based budget and manual budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "cbsSheetCodeId":{ "type":"integer", "description":"The unique identifier of a cost row item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedCost":{ "type":"number", "description":"The original cost of the scope assignment.
                                                                  If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
                                                                  If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingChangedCost":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. This field is in base currency and is calculated from pendingChangedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedChangedCost":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment. This field is in base currency and is calculated from approvedChangedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "revisedCost":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This field is in base currency and is calculated from revisedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "baselineCost":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedCost":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. This field is in base currency and is calculated from earnedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostToDate":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This field is in base currency and is calculated from actualCostToDateProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The amount left to be spent.
                                                                  If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                  If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "installedCost":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                  If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                  If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "adjustedCost":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. This field is in base currency and is calculated from adjustedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                  Calculated as Revised Cost plus Adjusted Cost. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentBudget":{ "type":"number", "description":"The total approved current manual budget of a project. Calculated as the sum of Approved Original Manual Budget plus Approved Manual Budget Changes plus Approved Manual Budget Transfers. This field is in base currency and is calculated from currentBudgetProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace1":{ "type":"number", "description":"Calculated as the sum of all current costs for the selected budget sources. Selected budget sources can include scope based budget and manual budget.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace2":{ "type":"number", "description":"Calculated as the sum of all current costs for the selected budget sources. Selected budget sources can include scope based budget and manual budget.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace3":{ "type":"number", "description":"Calculated as the sum of all current costs for the selected budget sources. Selected budget sources can include scope based budget and manual budget.", "format":"double", "exampleSetFlag":false }, "projectActualCost":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                  The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                  Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This field is in base currency and is calculated from projectActualCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "projectEarnedCost":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                  The cost value used for the Earned Value Management of a project.
                                                                  Earned Value Management allows project managers to quantify project progress and objectively measure a project's success. This field is in base currency and is calculated from projectEarnedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "projectCPI":{ "type":"number", "description":"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. This field is in base currency and is calculated from projectCPIProject field based on the specified exchange rate.", "exampleSetFlag":false, "types":[ "number" ] }, "plannedCostWorkspace1":{ "type":"number", "description":"The original cost of the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostWorkspace2":{ "type":"number", "description":"The original cost of the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostWorkspace3":{ "type":"number", "description":"The original cost of the scope assignment. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace1":{ "type":"number", "description":"The Original Cost before the baseline is set. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace2":{ "type":"number", "description":"The Original Cost before the baseline is set. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace3":{ "type":"number", "description":"The Original Cost before the baseline is set. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace1":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace2":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace3":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace1":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCost":{ "type":"number", "description":"The estimate of the cost needed to complete the work.
                                                                  Calculated as BAC Cost minus Earned Cost. This field is in base currency and is calculated from etcCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "eacCost":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. This field is in base currency and is calculated from eacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "bacCost":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. This field is in base currency and is calculated from bacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSSheetCodeInput":{ "title":"ApiEntityCBSSheetCodeInput", "required":[ "cbsCode", "projectId" ], "type":"object", "properties":{ "description":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the CBS code.", "exampleSetFlag":false, "types":[ "string" ] }, "parentCBSCodes":{ "type":"array", "description":"List of parent cbs codes in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "costSheetRow":{ "description":"A CBS sheet row object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSSheetRowInput" } ] }, "costSheetId":{ "type":"integer", "description":"The unique identifier of a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The system-generated identifier of a parent cost item in a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of cost sheet item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isActive":{ "type":"boolean", "description":"The active field indicates whether the CBS code is active for use.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costType":{ "type":"string", "description":"The category of the cost breakdown structure code.
                                                                  Expense: Represents an expense.
                                                                  Capital: Represents capital.
                                                                  None: Type is not divided into expense or capital. None is selected by default if no other choice is made.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE", "NONE" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a CBSSheetCode object, a unique CBSSheetCode object can be identified by the following combinations of the fields.
                                                                  • cbsSheetCodeId
                                                                  • cbsCode,projectId
                                                                  • cbsCode,projectCode,workspaceCode
                                                                    • ", "exampleSetFlag":false }, "ApiEntityCBSSheetRowConfiguredFieldValueInput":{ "title":"ApiEntityCBSSheetRowConfiguredFieldValueInput", "type":"object", "properties":{ "costSheetRowConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Project Cost Sheet Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costSheetRowId":{ "type":"integer", "description":"The system-generated identifier of a CBS Code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CBSSheetRowConfiguredFieldValue object, a unique CBSSheetRowConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                    • costSheetRowConfiguredFieldValueId
                                                                    • columnDefinitionId
                                                                    • columnName
                                                                    • columnLabel
                                                                      • ", "exampleSetFlag":false }, "ApiEntityCBSSheetRowInput":{ "title":"ApiEntityCBSSheetRowInput", "type":"object", "properties":{ "configuredFields":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSSheetRowConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityProjectCostingSource":{ "title":"ApiEntityProjectCostingSource", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectCostingSourceId":{ "type":"integer", "description":"The system-generated identifier of the project costing source.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualsSource":{ "type":"string", "description":"The source of project actuals.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SCOPE" ] }, "approvedActualsEnabled":{ "type":"boolean", "description":"Indicates project approved actuals are enabled.", "exampleSetFlag":false, "types":[ "boolean" ] }, "budgetSource":{ "type":"string", "description":"The source of a project budget.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SCOPE" ] }, "manualBudgetEnabled":{ "type":"boolean", "description":"Indicates a project manual budget is enabled.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectCostingSourceInput":{ "title":"ApiEntityProjectCostingSourceInput", "type":"object", "properties":{ "projectCostingSourceId":{ "type":"integer", "description":"The system-generated identifier of the project costing source.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualsSource":{ "type":"string", "description":"The source of project actuals.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SCOPE" ] }, "approvedActualsEnabled":{ "type":"boolean", "description":"Indicates project approved actuals are enabled.", "exampleSetFlag":false, "types":[ "boolean" ] }, "budgetSource":{ "type":"string", "description":"The source of a project budget.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SCOPE" ] }, "manualBudgetEnabled":{ "type":"boolean", "description":"Indicates a project manual budget is enabled.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCBSTemplateCode":{ "title":"ApiEntityCBSTemplateCode", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "templateRow":{ "description":"A CBS template row object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSTemplateRow" } ] }, "templateRowCost":{ "description":"A CBS template row cost object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSTemplateRowCost" } ] }, "description":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the CBS Code.", "exampleSetFlag":false, "types":[ "string" ] }, "parentCBSCodes":{ "type":"array", "description":"List of parent cbs codes in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "sequenceNumber":{ "type":"integer", "description":"Used to display the CBS codes in the increasing order of sequence numbers.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of the parent CBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsTemplateCodeId":{ "type":"integer", "description":"The unique identifier of the original CBS. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isActive":{ "type":"boolean", "description":"The active field indicates whether the CBS code is active for use.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costType":{ "type":"string", "description":"The category of the cost breakdown structure code.
                                                                      Expense: Represents an expense.
                                                                      Capital: Represents capital.
                                                                      None: Type is not divided into expense or capital. None is selected by default if no other choice is made.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE", "NONE" ] }, "copiedFromItemId":{ "type":"integer", "description":"The unique identifier for the CBS template that the CBS was copied from.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isCodeCopied":{ "type":"boolean", "description":"Indicates a CBS that is copied from a workspace or project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isTotalRow":{ "type":"boolean", "description":"The total cost of the project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "pushDownStatus":{ "type":"boolean", "description":"The push down status of a cbs template code. May be manual or automatic.", "exampleSetFlag":false, "types":[ "boolean" ] }, "cbsTemplateId":{ "type":"integer", "description":"The unique identifier for the CBS template.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code value of the CBS code. The code may have one or more segments according the ot the segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSTemplateRow":{ "title":"ApiEntityCBSTemplateRow", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "templateItemId":{ "type":"integer", "description":"The CBS code assigned to the line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsTemplateCodeId":{ "type":"integer", "description":"The CBS code assigned to the line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedHours":{ "type":"number", "description":"The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
                                                                      Calculated as Original Quantity multiplied by Original Productivity Rate.
                                                                      Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"Calculated as the sum of all pending hour changes in the change records for the scope assignment.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The sum of all approved change hours in the change and transfer records for the scope assignment.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "type":"number", "description":"Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "type":"number", "description":"The Revised Hours at the time the baseline was set.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "etcHours":{ "type":"number", "description":"The estimated number of hours needed to complete the work.
                                                                      Calculated as BAC Hours minus Earned Hours.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "eacHours":{ "type":"number", "description":"Calculated as ETC Hours plus Actual Hours to Date.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "earnedHours":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "etcAdjustedHours":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "actualHoursToDate":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "bacHours":{ "type":"number", "description":"The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "remainingHours":{ "type":"number", "description":"The number of hours left for the scope assignment.
                                                                      Calculated as Remaining Quantity multiplied by Revised Productivity Rate.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "installedHours":{ "type":"number", "description":"Hours spent on the scope assignment.
                                                                      Calculated as Installed Quantity multiplied by Revised Productivity Rate.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "atCompletionHours":{ "type":"number", "description":"The total hours expected for the scope assignment.
                                                                      Calculated as Revised Hours plus Adjusted Hours.
                                                                      This is the cumulative value for all objects in the workspace with the same CBS code.", "format":"double", "exampleSetFlag":false }, "projectHPI":{ "type":"number", "description":"Calculated as the total of Project Earned Hours divided by Project Actual Hours.", "format":"double", "exampleSetFlag":false }, "projectActualHours":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "projectEarnedHours":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSTemplateRowConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSTemplateRowConfiguredFieldValue":{ "title":"ApiEntityCBSTemplateRowConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCostSheetConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Workspace Cost Sheet Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costSheetRowId":{ "type":"integer", "description":"The system-generated identifier for an CBS Code assigned to the line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSTemplateRowCost":{ "title":"ApiEntityCBSTemplateRowCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "pendingChangedCostWorkspace1":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace2":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace3":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace1":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace2":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace3":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace1":{ "type":"number", "description":"The actual costs incurred on the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace2":{ "type":"number", "description":"The actual costs incurred on the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace3":{ "type":"number", "description":"The actual costs incurred on the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace1":{ "type":"number", "description":"The total cost at the completion of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace2":{ "type":"number", "description":"The total cost at the completion of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace3":{ "type":"number", "description":"The total cost at the completion of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace1":{ "type":"number", "description":"Total costs accrued on a project within a given time period, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace2":{ "type":"number", "description":"Total costs accrued on a project within a given time period, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace3":{ "type":"number", "description":"Total costs accrued on a project within a given time period, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace2":{ "type":"number", "description":"The estimate of the cost needed to complete the work, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace3":{ "type":"number", "description":"The estimate of the cost needed to complete the work, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace1":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace2":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace3":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace1":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace2":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace3":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace1":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace2":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace3":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace1":{ "type":"number", "description":"The amount left to be spent, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace2":{ "type":"number", "description":"The amount left to be spent, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace3":{ "type":"number", "description":"The amount left to be spent, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace1":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace2":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace3":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace1":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace2":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace3":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "cbsTemplateCodeId":{ "type":"integer", "description":"Template item ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedCost":{ "type":"number", "description":"The original cost of the scope assignment.
                                                                      If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
                                                                      If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity.", "format":"double", "exampleSetFlag":false }, "pendingChangedCost":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "approvedChangedCost":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "revisedCost":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost.", "format":"double", "exampleSetFlag":false }, "baselineCost":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set.", "format":"double", "exampleSetFlag":false }, "earnedCost":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost.", "format":"double", "exampleSetFlag":false }, "actualCostToDate":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The amount left to be spent.
                                                                      If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                      If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate.", "format":"double", "exampleSetFlag":false }, "installedCost":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                      If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                      If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity.", "format":"double", "exampleSetFlag":false }, "adjustedCost":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                      Calculated as Revised Cost plus Adjusted Cost.", "format":"double", "exampleSetFlag":false }, "currentBudget":{ "type":"number", "description":"The total approved current manual budget of a project.Calculated as the sum of Approved Original Manual Budget plus Approved Manual Budget Changes plus Approved Manual Budget Transfers.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace1":{ "type":"number", "description":"Workspace current budget.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace2":{ "type":"number", "description":"Workspace current budget.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace3":{ "type":"number", "description":"Workspace current budget.", "format":"double", "exampleSetFlag":false }, "projectActualCost":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable.", "format":"double", "exampleSetFlag":false }, "projectEarnedCost":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                      The cost value used for the Earned Value Management of a project.
                                                                      Earned Value Management allows project managers to quantify project progress and objectively measure a project's success.", "format":"double", "exampleSetFlag":false }, "projectCPI":{ "type":"number", "description":"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.", "exampleSetFlag":false, "types":[ "number" ] }, "plannedCostWorkspace1":{ "type":"number", "description":"The original cost of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostWorkspace2":{ "type":"number", "description":"The original cost of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostWorkspace3":{ "type":"number", "description":"The original cost of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace1":{ "type":"number", "description":"The Original Cost before the baseline is set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace2":{ "type":"number", "description":"The Original Cost before the baseline is set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace3":{ "type":"number", "description":"The Original Cost before the baseline is set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace1":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace2":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace3":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace1":{ "type":"number", "description":"The estimate of the cost needed to complete the work, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCost":{ "type":"number", "description":"The estimate of the cost needed to complete the work.
                                                                      Calculated as BAC Cost minus Earned Cost.", "format":"double", "exampleSetFlag":false }, "eacCost":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date.", "format":"double", "exampleSetFlag":false }, "bacCost":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSTemplateCodeInput":{ "title":"ApiEntityCBSTemplateCodeInput", "required":[ "workspaceId" ], "type":"object", "properties":{ "templateRow":{ "description":"A CBS template row object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSTemplateRowInput" } ] }, "description":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the CBS Code.", "exampleSetFlag":false, "types":[ "string" ] }, "parentCBSCodes":{ "type":"array", "description":"List of parent cbs codes in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of the parent CBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsTemplateCodeId":{ "type":"integer", "description":"The unique identifier of the original CBS. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isActive":{ "type":"boolean", "description":"The active field indicates whether the CBS code is active for use.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costType":{ "type":"string", "description":"The category of the cost breakdown structure code.
                                                                      Expense: Represents an expense.
                                                                      Capital: Represents capital.
                                                                      None: Type is not divided into expense or capital. None is selected by default if no other choice is made.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE", "NONE" ] }, "copiedFromItemId":{ "type":"integer", "description":"The unique identifier for the CBS template that the CBS was copied from.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownStatus":{ "type":"boolean", "description":"The push down status of a cbs template code. May be manual or automatic.", "exampleSetFlag":false, "types":[ "boolean" ] }, "cbsTemplateId":{ "type":"integer", "description":"The unique identifier for the CBS template.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code value of the CBS code. The code may have one or more segments according the ot the segment definition.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a CBSTemplateCode object, a unique CBSTemplateCode object can be identified by the following combinations of the fields.
                                                                      • cbsTemplateCodeId
                                                                      • cbsCode,workspaceId
                                                                      • cbsCode,workspaceCode
                                                                        • ", "exampleSetFlag":false }, "ApiEntityCBSTemplateRowConfiguredFieldValueInput":{ "title":"ApiEntityCBSTemplateRowConfiguredFieldValueInput", "type":"object", "properties":{ "workspaceCostSheetConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Workspace Cost Sheet Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costSheetRowId":{ "type":"integer", "description":"The system-generated identifier for an CBS Code assigned to the line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CBSTemplateRowConfiguredFieldValue object, a unique CBSTemplateRowConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                        • workspaceCostSheetConfiguredValueId
                                                                        • columnDefinitionId
                                                                        • columnName
                                                                        • columnLabel
                                                                          • ", "exampleSetFlag":false }, "ApiEntityCBSTemplateRowInput":{ "title":"ApiEntityCBSTemplateRowInput", "type":"object", "properties":{ "configuredFields":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCBSTemplateRowConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedCBSSheetCode":{ "title":"ApiEntityExternallySourcedCBSSheetCode", "required":[ "cbsCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "copiedFromItem":{ "type":"integer", "description":"The unique identifier for the original ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "description":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the CBS code.", "exampleSetFlag":false, "types":[ "string" ] }, "parentCBSCodes":{ "type":"array", "description":"List of parent cbs codes in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "costSheetRow":{ "description":"A CBS sheet row object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSSheetRow" } ] }, "costSheetRowCost":{ "description":"The cost of a CBS sheet row.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSSheetRowCost" } ] }, "costSheetId":{ "type":"integer", "description":"The unique identifier of a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"Number that specifies the position of the cost sheet item.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The system-generated identifier of a parent cost item in a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of cost sheet item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isActive":{ "type":"boolean", "description":"The active field indicates whether the CBS code is active for use.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costType":{ "type":"string", "description":"The category of the cost breakdown structure code.
                                                                          Expense: Represents an expense.
                                                                          Capital: Represents capital.
                                                                          None: Type is not divided into expense or capital. None is selected by default if no other choice is made.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE", "NONE" ] }, "isTotalRow":{ "type":"boolean", "description":"Indicates this item represents the total cost of the project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceTotalItem":{ "title":"ApiEntityWorkspaceTotalItem", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "workspaceTotalRow":{ "description":"Defines the spread rows for a workspace total item.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityWorkspaceTotalRow" } ] }, "workspaceTotalRowCost":{ "description":"Defines the cost associated with the spread rows of the workspace total item.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityWorkspaceTotalRowCost" } ] }, "parentWorkspace":{ "type":"integer", "description":"The unique identifier of the workspace hierarchically above another workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "aggregateId":{ "type":"integer", "description":"The unique identifier of the rollup record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rollupType":{ "type":"string", "description":"The rollupType specifies whether the rollup values belong to a project or a workspace.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE", "PROJECT", "PROGRAM" ] }, "referenceObjectId":{ "type":"integer", "description":"The unique identifier of the project or workspace that owns the cost values.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceTotalRow":{ "title":"ApiEntityWorkspaceTotalRow", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "aggregateId":{ "type":"integer", "description":"The unique identifier of the rollup record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedHours":{ "type":"number", "description":"The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
                                                                          Calculated as Original Quantity multiplied by Original Productivity Rate.
                                                                          Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"Calculated as the sum of all pending hour changes in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The sum of all approved change hours in the change and transfer records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "type":"number", "description":"Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "type":"number", "description":"The Revised Hours at the time the baseline was set.", "format":"double", "exampleSetFlag":false }, "etcHours":{ "type":"number", "description":"The estimated number of hours needed to complete the work.
                                                                          Calculated as BAC Hours minus Earned Hours.", "format":"double", "exampleSetFlag":false }, "eacHours":{ "type":"number", "description":"Calculated as ETC Hours plus Actual Hours to Date.", "format":"double", "exampleSetFlag":false }, "earnedHours":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.", "format":"double", "exampleSetFlag":false }, "etcAdjustedHours":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.", "format":"double", "exampleSetFlag":false }, "actualHoursToDate":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "bacHours":{ "type":"number", "description":"The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "remainingHours":{ "type":"number", "description":"The number of hours left for the scope assignment.
                                                                          Calculated as Remaining Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false }, "installedHours":{ "type":"number", "description":"Hours spent on the scope assignment.
                                                                          Calculated as Installed Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false }, "atCompletionHours":{ "type":"number", "description":"The total hours expected for the scope assignment.
                                                                          Calculated as Revised Hours plus Adjusted Hours.", "format":"double", "exampleSetFlag":false }, "projectHPI":{ "type":"number", "description":"Calculated as the total of Project Earned Hours divided by Project Actual Hours.", "format":"double", "exampleSetFlag":false }, "projectActualHours":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "projectEarnedHours":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceTotalRowCost":{ "title":"ApiEntityWorkspaceTotalRowCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "pendingChangedCostWorkspace1":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace2":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency. ", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace3":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace1":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace2":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace3":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace1":{ "type":"number", "description":"The actual costs incurred on the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace2":{ "type":"number", "description":"The actual costs incurred on the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace3":{ "type":"number", "description":"The actual costs incurred on the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace1":{ "type":"number", "description":"The total cost at the completion of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace2":{ "type":"number", "description":"The total cost at the completion of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace3":{ "type":"number", "description":"The total cost at the completion of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace1":{ "type":"number", "description":"Total costs accrued on a project within a given time period based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace2":{ "type":"number", "description":"Total costs accrued on a project within a given time period based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace3":{ "type":"number", "description":"Total costs accrued on a project within a given time period based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "workspaceTotalItemId":{ "type":"integer", "description":"The system-generated identifier of a workspace total item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "etcCostWorkspace2":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace3":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace1":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace2":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace3":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace1":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace2":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace3":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace1":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method based on the workspace currency.The Revised Cost of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace2":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method based on the workspace currency.The Revised Cost of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace3":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method based on the workspace currency.The Revised Cost of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace1":{ "type":"number", "description":"The amount left to be spent, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace2":{ "type":"number", "description":"The amount left to be spent, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace3":{ "type":"number", "description":"The amount left to be spent, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace1":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace2":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace3":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace1":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace2":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace3":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCost":{ "type":"number", "description":"The original cost of the scope assignment.
                                                                          If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
                                                                          If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity.", "format":"double", "exampleSetFlag":false }, "pendingChangedCost":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "approvedChangedCost":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "revisedCost":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost.", "format":"double", "exampleSetFlag":false }, "baselineCost":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set.", "format":"double", "exampleSetFlag":false }, "earnedCost":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost.", "format":"double", "exampleSetFlag":false }, "actualCostToDate":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The amount left to be spent.
                                                                          If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                          If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate.", "format":"double", "exampleSetFlag":false }, "installedCost":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                          If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                          If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity.", "format":"double", "exampleSetFlag":false }, "adjustedCost":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                          Calculated as Revised Cost plus Adjusted Cost.", "format":"double", "exampleSetFlag":false }, "currentBudget":{ "type":"number", "description":"The total approved current manual budget of a project.Calculated as the sum of Approved Original Manual Budget plus Approved Manual Budget Changes plus Approved Manual Budget Transfers.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace1":{ "type":"number", "description":"The total approved manual budget of a set of projects, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace2":{ "type":"number", "description":"The total approved manual budget of a set of projects, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace3":{ "type":"number", "description":"The total approved manual budget of a set of projects, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCost":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                          The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                          Actual Cost data is only available when the application is connected with P6 EPPM and is not editable.", "format":"double", "exampleSetFlag":false }, "projectEarnedCost":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                          The cost value used for the Earned Value Management of a project.
                                                                          Earned Value Management allows project managers to quantify project progress and objectively measure a project's success.", "format":"double", "exampleSetFlag":false }, "projectCPI":{ "type":"number", "description":"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.", "exampleSetFlag":false, "types":[ "number" ] }, "plannedCostWorkspace1":{ "type":"number", "description":"The original cost of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostWorkspace2":{ "type":"number", "description":"The original cost of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostWorkspace3":{ "type":"number", "description":"The original cost of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace1":{ "type":"number", "description":"The Original Cost before the baseline is set based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace2":{ "type":"number", "description":"The Original Cost before the baseline is set based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace3":{ "type":"number", "description":"The Original Cost before the baseline is set based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace1":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace2":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace3":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace1":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCost":{ "type":"number", "description":"The estimate of the cost needed to complete the work.
                                                                          Calculated as BAC Cost minus Earned Cost.", "format":"double", "exampleSetFlag":false }, "eacCost":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date.", "format":"double", "exampleSetFlag":false }, "bacCost":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRecalculateWorkspaceCostSheetInput":{ "title":"ApiEntityRecalculateWorkspaceCostSheetInput", "type":"object", "properties":{ "projectFormulaConfiguredFieldsRecalculate":{ "type":"boolean", "description":"Boolean flag to indicate whether Formula configured fields need to be updated based on existing project data. To ensure the latest project costs, recalculate the project costs before recalculating these fields.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workspaceRecalculate":{ "type":"boolean", "description":"Boolean flag to indicate whether workspace totals need to be updated based on current cost data from projects and child workspaces.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectRecalculate":{ "type":"boolean", "description":"Boolean flag to indicate whether all projects' cost fields based on the provided cost field types, need to be updated in the summary cost sheet.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectCostFieldTypes":{ "type":"array", "description":"Cost types to include in project cost sheet recalculation. Required if project recalculate boolean flag is provided as true. 'FORMULA_CONFIGURED_FIELDS' type is deprecated and will be removed soon, to update formula configured fields, use the 'projectFormulaConfiguredFieldsRecalculate' boolean field.
                                                                          Allowed Values are: ACTUALS, BUDGET, COMMITMENTS, CONTRACTS, RISKS, SCOPE.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTUALS", "BUDGET", "COMMITMENTS", "CONTRACTS", "RISKS", "SCOPE", "FORMULA_CONFIGURED_FIELDS" ] }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedCBSSheetCodeInput":{ "title":"ApiEntityExternallySourcedCBSSheetCodeInput", "required":[ "cbsCode", "projectId" ], "type":"object", "properties":{ "description":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the CBS code.", "exampleSetFlag":false, "types":[ "string" ] }, "parentCBSCodes":{ "type":"array", "description":"List of parent cbs codes in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "costSheetRow":{ "description":"A CBS sheet row object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSSheetRowInput" } ] }, "costSheetId":{ "type":"integer", "description":"The unique identifier of a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The system-generated identifier of a parent cost item in a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of cost sheet item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isActive":{ "type":"boolean", "description":"The active field indicates whether the CBS code is active for use.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costType":{ "type":"string", "description":"The category of the cost breakdown structure code.
                                                                          Expense: Represents an expense.
                                                                          Capital: Represents capital.
                                                                          None: Type is not divided into expense or capital. None is selected by default if no other choice is made.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE", "NONE" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ExternallySourcedCBSSheetCode object, a unique ExternallySourcedCBSSheetCode object can be identified by the following combinations of the fields.
                                                                          • cbsSheetCodeId
                                                                          • cbsCode,projectId
                                                                          • cbsCode,projectCode,workspaceCode
                                                                            • ", "exampleSetFlag":false }, "ApiEntityCalendar":{ "title":"ApiEntityCalendar", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"Specifies how a workspace calendar is shared across child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the calendar and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "isAssignableToProject":{ "type":"boolean", "description":"Indicates whether or not the calendar can be assigned to a project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isAssignableToResource":{ "type":"boolean", "description":"Indicates whether or not the calendar can be assigned to a resource.", "exampleSetFlag":false, "types":[ "boolean" ] }, "calendarExceptions":{ "type":"array", "description":"Defines exceptions to the specified calendar.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendarException", "exampleSetFlag":false }, "types":[ "array" ] }, "workTimeSunday":{ "maxLength":48, "type":"string", "description":"The working time for Sunday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeMonday":{ "maxLength":48, "type":"string", "description":"The working time for Monday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeTuesday":{ "maxLength":48, "type":"string", "description":"The working time for Tuesday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeWednesday":{ "maxLength":48, "type":"string", "description":"The working time for Wednesday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeThursday":{ "maxLength":48, "type":"string", "description":"The working time for Thursday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeFriday":{ "maxLength":48, "type":"string", "description":"The working time for Friday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeSaturday":{ "maxLength":48, "type":"string", "description":"The working time for Saturday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "monthHourCount":{ "type":"number", "description":"The number of hours in a month.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "dayHourCount":{ "type":"number", "description":"The number of hours in a day.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "yearHourCount":{ "type":"number", "description":"The number of hours in a year.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "weekHourCount":{ "type":"number", "description":"The number of hours in a week.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "holidayMoveType":{ "type":"string", "description":"Specifies a holiday within calendar work time.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "FORWARD", "BACKWARD", "CLOSEST_WORK_DAY" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "holiday":{ "type":"integer", "description":"The holiday list assigned to the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCalendarException":{ "title":"ApiEntityCalendarException", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workTime":{ "maxLength":4000, "type":"string", "description":"Work time that is non-standard.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "exceptionName":{ "maxLength":60, "type":"string", "description":"The name of the exception for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "exceptionDate":{ "type":"string", "description":"The date that is marked as an exception. An exception is a change to the regularly scheduled time in the calendar.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "calendarExceptionId":{ "type":"integer", "description":"The unique identifier for the calendar exception.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCalendarExceptionInput":{ "title":"ApiEntityCalendarExceptionInput", "required":[ "calendarId", "exceptionDate" ], "type":"object", "properties":{ "workTime":{ "maxLength":4000, "type":"string", "description":"Work time that is non-standard.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "exceptionName":{ "maxLength":60, "type":"string", "description":"The name of the exception for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "exceptionDate":{ "type":"string", "description":"The date that is marked as an exception. An exception is a change to the regularly scheduled time in the calendar.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "calendarExceptionId":{ "type":"integer", "description":"The unique identifier for the calendar exception.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCalendarInput":{ "title":"ApiEntityCalendarInput", "required":[ "calendarName", "workTimeFriday", "workTimeMonday", "workTimeSaturday", "workTimeSunday", "workTimeThursday", "workTimeTuesday", "workTimeWednesday", "workspaceId" ], "type":"object", "properties":{ "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"Specifies how a workspace calendar is shared across child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "isAssignableToProject":{ "type":"boolean", "description":"Indicates whether or not the calendar can be assigned to a project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isAssignableToResource":{ "type":"boolean", "description":"Indicates whether or not the calendar can be assigned to a resource.", "exampleSetFlag":false, "types":[ "boolean" ] }, "calendarExceptions":{ "type":"array", "description":"Defines exceptions to the specified calendar.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendarExceptionInput", "exampleSetFlag":false }, "types":[ "array" ] }, "workTimeSunday":{ "maxLength":48, "type":"string", "description":"The working time for Sunday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeMonday":{ "maxLength":48, "type":"string", "description":"The working time for Monday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeTuesday":{ "maxLength":48, "type":"string", "description":"The working time for Tuesday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeWednesday":{ "maxLength":48, "type":"string", "description":"The working time for Wednesday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeThursday":{ "maxLength":48, "type":"string", "description":"The working time for Thursday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeFriday":{ "maxLength":48, "type":"string", "description":"The working time for Friday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "workTimeSaturday":{ "maxLength":48, "type":"string", "description":"The working time for Saturday.
                                                                            The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
                                                                            For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
                                                                            000000000000000000111111111111111100000000000000", "exampleSetFlag":false, "types":[ "string" ] }, "monthHourCount":{ "type":"number", "description":"The number of hours in a month.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "dayHourCount":{ "type":"number", "description":"The number of hours in a day.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "yearHourCount":{ "type":"number", "description":"The number of hours in a year.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "weekHourCount":{ "type":"number", "description":"The number of hours in a week.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "holidayMoveType":{ "type":"string", "description":"Specifies a holiday within calendar work time.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "FORWARD", "BACKWARD", "CLOSEST_WORK_DAY" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "holiday":{ "type":"integer", "description":"The holiday list assigned to the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a Calendar object, a unique Calendar object can be identified by the following combinations of the fields.
                                                                            • calendarId
                                                                            • calendarCode,workspaceId
                                                                            • calendarCode,workspaceCode
                                                                            • calendarCode,projectId
                                                                            • calendarCode,projectCode,workspaceCode
                                                                            • calendarCode,projectCode,workspaceId
                                                                              • ", "exampleSetFlag":false }, "ApiEntityPromoteProjectCalendar":{ "title":"ApiEntityPromoteProjectCalendar", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarCode":{ "maxLength":255, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace for which the calendar belongs.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project for which the calendar belongs.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioUserPermissionsResponse":{ "title":"ApiEntityPortfolioUserPermissionsResponse", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"Profiles response with individual message and statusCodes.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfileResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProfileResponse":{ "title":"ApiEntityProfileResponse", "type":"object", "properties":{ "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "message":{ "type":"string", "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "profileId":{ "maxLength":255, "type":"string", "description":"The system-defined unique identifier of an object profile.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioProfileInput":{ "title":"ApiEntityPortfolioProfileInput", "type":"object", "properties":{ "fileProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the document profile.", "exampleSetFlag":false, "types":[ "string" ] }, "reportProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the report profile.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the portfolio profile.", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioUserPermissions":{ "title":"ApiEntityPortfolioUserPermissions", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValuePortfolio":{ "title":"ApiEntityCodeValuePortfolio", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValuePortfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityDateComputation":{ "title":"ApiEntityDateComputation", "type":"object", "properties":{ "computationType":{ "type":"string", "description":"
                                                                              • DAYS_FROM_CURRENT_DATE: It indicates the date calculated as an increment or decrement of the number of days provided in the computationValue from the current date.
                                                                              • WEEKS_FROM_CURRENT_DATE: It indicates the date calculated as an increment or decrement of the number of weeks provided in the computationValue from the current date.
                                                                              • MONTHS_FROM_CURRENT_DATE - It indicates the date calculated as an increment or decrement of the number of months provided in the computationValue from the current date.
                                                                              • QUARTERS_FROM_CURRENT_DATE: It indicates the date calculated as an increment or decrement of quarters in a year provided in the computationValue from the current date.
                                                                              • YEARS_FROM_CURRENT_DATE: It indicates the date calculated as an increment or decrement of the number of years provided in the computationValue from the current date.
                                                                              • WEEKS_FROM_CURRENT_WEEK: It indicates the date calculated as an increment or decrement of the number of weeks provided in the computationValue from the current week.
                                                                              • MONTHS_FROM_CURRENT_MONTH: It indicates the date calculated as an increment or decrement of the number of months provided in the computationValue from the current month.
                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DAYS_FROM_CURRENT_DATE", "WEEKS_FROM_CURRENT_DATE", "MONTHS_FROM_CURRENT_DATE", "QUARTERS_FROM_CURRENT_DATE", "YEARS_FROM_CURRENT_DATE", "WEEKS_FROM_CURRENT_WEEK", "MONTHS_FROM_CURRENT_MONTH" ] }, "computationValue":{ "type":"number", "description":"The value used to calculate the date based on the value provided in computationType field.", "exampleSetFlag":false, "types":[ "number" ] } }, "exampleSetFlag":false }, "ApiEntityDateFilter":{ "title":"ApiEntityDateFilter", "type":"object", "properties":{ "dateType":{ "type":"string", "description":"
                                                                              • CUSTOM_DATE: Custom date is used to provide a specific date in the dateValue field.
                                                                                • COMPUTED_DATE: Computed date is used to provide a calculated date in the dateValue field. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CUSTOM_DATE", "COMPUTED_DATE" ] }, "dateValue":{ "type":"object", "description":"
                                                                                • String type is used for providing a specific date when the dateType is CUSTOM_DATE.
                                                                                • ApiEntityDateComputation type is for providing a calculated date when the dateType is COMPUTED_DATE.
                                                                                ", "exampleSetFlag":false, "oneOf":[ { "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, { "$ref":"#/components/schemas/ApiEntityDateComputation", "exampleSetFlag":false } ] } }, "exampleSetFlag":false }, "ApiEntityPortfolio":{ "title":"ApiEntityPortfolio", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "filter":{ "maxLength":4000, "type":"string", "description":"Determines if projects included in the portfolio must meet all or any of the defined filter rules.
                                                                                Selecting an appropriate filter criteria helps specify the portfolio's project inclusions.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValuesPortfolio":{ "type":"array", "description":"The list of code values for a portfolio. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValuePortfolio", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary for the portfolio.
                                                                                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.", "exampleSetFlag":false, "types":[ "string" ] }, "programs":{ "type":"array", "description":"The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "planningHorizon":{ "minimum":1, "type":"integer", "description":"The Planning Horizon defines the duration of budget planning within the portfolio.
                                                                                For example, the U.S. government plans six years of capital spending, in this case their planning horizon would be six years.
                                                                                The Planning Horizon is separated by yearly Planning Periods, during which budget values allocated to yearly projects, and planning for the year takes place.
                                                                                Returning to the example, the U.S. Government would establish a Planning Period budget six times, as they have a Planning Horizon of six years.
                                                                                Planning Horizon can be edited at any point in time during the planning process.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "yearsPlannedInMonth":{ "type":"integer", "description":"Years Planned in Months specifies the number of years within the Planning Horizon that will be time phased in monthly increments.
                                                                                The number of years planned in months cannot be greater than the portfolio's Planning Horizon.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "yearsPlannedInQuarter":{ "type":"integer", "description":"Years Planned in Quarters specifies the number of years within the Planning Horizon that will be time phased in quarterly increments.
                                                                                The number of years planned in quarters cannot be greater than the portfolio's Planning Horizon.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "yearsPlannedInYear":{ "type":"integer", "description":"Years Planned in Years specifies the number of years within the Planning Horizon that will be time phased in yearly increments.
                                                                                The number of Years Planned In Years cannot be greater than the portfolio's Planning Horizon.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "linkType":{ "type":"string", "description":"Determines if linked projects in the portfolio budget plan link to project Forecast or Planned Budget.
                                                                                Linked values will be factored into a budget plan's Proposed Budget.
                                                                                Planner's can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans.
                                                                                Any portfolio budget plans added to a portfolio will inherit the value of its Proposed Budget Link Setting by default.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FORECAST", "PLANNED_BUDGET" ] }, "securityGuid":{ "maxLength":32, "type":"string", "description":"Globally unique identifier of a portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "autoRefresh":{ "type":"boolean", "description":"Indicates whether the portfolio is set to refresh automatically.", "exampleSetFlag":false, "types":[ "boolean" ] }, "periodId":{ "type":"integer", "description":"The unique identifier of a portfolio period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodType":{ "type":"string", "description":"The frequency of portfolio refresh period.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DAILY", "WEEKLY_END_ON_SUN", "WEEKLY_END_ON_MON", "WEEKLY_END_ON_TUE", "WEEKLY_END_ON_WED", "WEEKLY_END_ON_THU", "WEEKLY_END_ON_FRI", "WEEKLY_END_ON_SAT", "SEMIMONTHLY", "MONTHLY_START_OF_MONTH", "MONTHLY_MID_MONTH" ] }, "programFilter":{ "type":"array", "description":"CP_PORTFOLIO,PROGRAM_FILTER", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramFilter", "exampleSetFlag":false }, "types":[ "array" ] }, "workspace":{ "type":"integer", "description":"The workspace ID for the portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "lastRefreshDate":{ "type":"string", "description":"The date a refresh was last performed on the filter for the portfolio. The projects available in the portfolio are up-to-date as of the last refresh date.", "format":"date-time", "exampleSetFlag":false }, "breakdownEnabled":{ "type":"boolean", "description":"The setting to enable capital and expense breakdown for a portfolio.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownType":{ "type":"string", "description":"The sub-cost curve to which the existing portfolio cost data will be mapped. The selected sub-cost curve will be used when linking a project's cost curve values.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE" ] }, "projects":{ "type":"array", "description":"The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioProject", "exampleSetFlag":false }, "types":[ "array" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a portfolio.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "image":{ "description":"The image that represents the capital portfolio.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityPortfolioImage" } ] }, "ownerId":{ "type":"integer", "description":"The owner of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioConfiguredFieldValue":{ "title":"ApiEntityPortfolioConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "capitalPortfolioConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Portfolio Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The system-generated identifier for a Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioImage":{ "title":"ApiEntityPortfolioImage", "required":[ "portfolio" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "portfolio":{ "type":"integer", "description":"Unique identifier of the portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioImageId":{ "type":"integer", "description":"Unique identifier of the portfolio image.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "imageType":{ "type":"string", "description":"The mime type of an image associated with a portfolio.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PNG", "JPEG", "GIF" ] }, "image":{ "type":"string", "description":"The image that represents the portfolio.", "format":"byte", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioProgram":{ "title":"ApiEntityPortfolioProgram", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The portfolio that includes the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioProgramId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioProject":{ "title":"ApiEntityPortfolioProject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectPortfolioProjectId":{ "type":"integer", "description":"The unique identifier of a project contained in a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The portfolio that includes the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "review":{ "type":"boolean", "description":"Indicates a project in the capital plan is currently undergoing review.", "exampleSetFlag":false, "types":[ "boolean" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramFilter":{ "title":"ApiEntityProgramFilter", "type":"object", "properties":{ "fieldName":{ "type":"object", "description":"The program field on which the filter needs to be applied.
                                                                                • The list of fields supported for filtering with String type are: spendEffectiveDate, actualFinish, actualStart, forecastFinishDate, forecastStartDate, plannedFinish, plannedStart, statusDate, businessImpact, updateDate, description, programCode, linkForecastToSpend, programName, problemOrOpportunity, status, strategicObjective, evaluationScore. In addition, filtering is also possible on the following non-API exposed program fields: createDate and strategyProgramAlignScore.
                                                                                • The ConfiguredFieldIdentifier type is used for filtering program configured fields.
                                                                                • The CodeTypeIdentifier type is used for filtering program code types.
                                                                                ", "exampleSetFlag":false, "oneOf":[ { "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, { "$ref":"#/components/schemas/ConfiguredFieldIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CodeTypeIdentifier", "exampleSetFlag":false } ] }, "operator":{ "type":"string", "description":"Equality condition.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EQUALS", "NOT_EQUALS", "EQUALS_IGNORE_CASE", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "IN", "NOT_IN", "STARTS_WITH", "ENDS_WITH", "LIKE", "NOT_LIKE", "BETWEEN", "NOT_BETWEEN", "IS_NULL", "NOT_NULL", "IS_EMPTY", "IS_UNDER" ] }, "fieldValue":{ "type":"object", "description":"Field value for filtering.
                                                                                • ApiEntityDateFilter type is for performing filtering on any date fields, such as when the fieldName is provided with any dates.
                                                                                • The CodeValueIdentifier type is for performing filtering on program code types i.e. when the fieldName is provided with the CodeTypeIdentifier value
                                                                                • The String type value is for any other fields other than the ones mentioned already.
                                                                                ", "exampleSetFlag":false, "oneOf":[ { "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, { "$ref":"#/components/schemas/CodeValueIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ApiEntityDateFilter", "exampleSetFlag":false } ] }, "join":{ "type":"string", "description":"Join condition", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "AND", "OR", "NULL" ] } }, "exampleSetFlag":false }, "ConfiguredFieldIdentifier":{ "title":"ConfiguredFieldIdentifier", "type":"object", "properties":{ "viewColumnName":{ "type":"string", "description":"The view column name of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "flexObject":{ "type":"string", "description":"Flex Object to be saved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "DOCUMENT", "FUND", "IDEA", "PORTFOLIO", "PROGRAM", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "STRATEGY", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "label":{ "type":"string", "description":"The label of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValuePortfolioInput":{ "title":"ApiEntityCodeValuePortfolioInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValuePortfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValuePortfolio object, a unique CodeValuePortfolio object can be identified by the following combinations of the fields.
                                                                                • codeValuePortfolioId
                                                                                • codeValueId
                                                                                • codeTypeId,codeValueCode
                                                                                • codeTypeCode,codeValueCode
                                                                                • codeTypeCode,parentId,codeValueCode
                                                                                • codeValueCode,codeTypeId,parentId
                                                                                • codeTypeCode,codeValueCode,projectCode
                                                                                • codeTypeCode,codeValueCode,projectId
                                                                                • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                • codeTypeCode,codeValueCode,parentId,projectId
                                                                                  • ", "exampleSetFlag":false }, "ApiEntityPortfolioConfiguredFieldValueInput":{ "title":"ApiEntityPortfolioConfiguredFieldValueInput", "type":"object", "properties":{ "capitalPortfolioConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Portfolio Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The system-generated identifier for a Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a PortfolioConfiguredFieldValue object, a unique PortfolioConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                  • capitalPortfolioConfiguredFieldValueId
                                                                                  • columnDefinitionId
                                                                                  • columnName
                                                                                  • columnLabel
                                                                                    • ", "exampleSetFlag":false }, "ApiEntityPortfolioImageInput":{ "title":"ApiEntityPortfolioImageInput", "required":[ "image", "imageType", "portfolio" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "portfolio":{ "type":"integer", "description":"Unique identifier of the portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioImageId":{ "type":"integer", "description":"Unique identifier of the portfolio image.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "imageType":{ "type":"string", "description":"The mime type of an image associated with a portfolio.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PNG", "JPEG", "GIF" ] }, "image":{ "type":"string", "description":"The image that represents the portfolio.", "format":"byte", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioInput":{ "title":"ApiEntityPortfolioInput", "required":[ "name", "workspaceId", "yearsPlannedInMonth", "yearsPlannedInQuarter", "yearsPlannedInYear" ], "type":"object", "properties":{ "name":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "filter":{ "maxLength":4000, "type":"string", "description":"Determines if projects included in the portfolio must meet all or any of the defined filter rules.
                                                                                    Selecting an appropriate filter criteria helps specify the portfolio's project inclusions.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValuesPortfolio":{ "type":"array", "description":"The list of code values for a portfolio. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValuePortfolioInput", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary for the portfolio.
                                                                                    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.", "exampleSetFlag":false, "types":[ "string" ] }, "programs":{ "type":"array", "description":"The Capital Plan Portfolio service enables you to create, update, view, and delete budget plan portfolios.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioProgramInput", "exampleSetFlag":false }, "types":[ "array" ] }, "planningHorizon":{ "minimum":1, "type":"integer", "description":"The Planning Horizon defines the duration of budget planning within the portfolio.
                                                                                    For example, the U.S. government plans six years of capital spending, in this case their planning horizon would be six years.
                                                                                    The Planning Horizon is separated by yearly Planning Periods, during which budget values allocated to yearly projects, and planning for the year takes place.
                                                                                    Returning to the example, the U.S. Government would establish a Planning Period budget six times, as they have a Planning Horizon of six years.
                                                                                    Planning Horizon can be edited at any point in time during the planning process.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "yearsPlannedInMonth":{ "type":"integer", "description":"Years Planned in Months specifies the number of years within the Planning Horizon that will be time phased in monthly increments.
                                                                                    The number of years planned in months cannot be greater than the portfolio's Planning Horizon.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "yearsPlannedInQuarter":{ "type":"integer", "description":"Years Planned in Quarters specifies the number of years within the Planning Horizon that will be time phased in quarterly increments.
                                                                                    The number of years planned in quarters cannot be greater than the portfolio's Planning Horizon.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "yearsPlannedInYear":{ "type":"integer", "description":"Years Planned in Years specifies the number of years within the Planning Horizon that will be time phased in yearly increments.
                                                                                    The number of Years Planned In Years cannot be greater than the portfolio's Planning Horizon.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "linkType":{ "type":"string", "description":"Determines if linked projects in the portfolio budget plan link to project Forecast or Planned Budget.
                                                                                    Linked values will be factored into a budget plan's Proposed Budget.
                                                                                    Planner's can easily see the value differences between the project manager's budgets for the plan's included projects and their own budgetary plans.
                                                                                    Any portfolio budget plans added to a portfolio will inherit the value of its Proposed Budget Link Setting by default.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FORECAST", "PLANNED_BUDGET" ] }, "autoRefresh":{ "type":"boolean", "description":"Indicates whether the portfolio is set to refresh automatically.", "exampleSetFlag":false, "types":[ "boolean" ] }, "periodId":{ "type":"integer", "description":"The unique identifier of a portfolio period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodType":{ "type":"string", "description":"The frequency of portfolio refresh period.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DAILY", "WEEKLY_END_ON_SUN", "WEEKLY_END_ON_MON", "WEEKLY_END_ON_TUE", "WEEKLY_END_ON_WED", "WEEKLY_END_ON_THU", "WEEKLY_END_ON_FRI", "WEEKLY_END_ON_SAT", "SEMIMONTHLY", "MONTHLY_START_OF_MONTH", "MONTHLY_MID_MONTH" ] }, "programFilter":{ "type":"array", "description":"CP_PORTFOLIO,PROGRAM_FILTER", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramFilterInput", "exampleSetFlag":false }, "types":[ "array" ] }, "workspace":{ "type":"integer", "description":"The workspace ID for the portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "breakdownEnabled":{ "type":"boolean", "description":"The setting to enable capital and expense breakdown for a portfolio.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownType":{ "type":"string", "description":"The sub-cost curve to which the existing portfolio cost data will be mapped. The selected sub-cost curve will be used when linking a project's cost curve values.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CAPITAL", "EXPENSE" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a portfolio.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPortfolioConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "image":{ "description":"The image that represents the capital portfolio.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityPortfolioImageInput" } ] }, "ownerId":{ "type":"integer", "description":"The owner of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a Portfolio object, a unique Portfolio object can be identified by the following combinations of the fields.
                                                                                    • portfolioId
                                                                                    • name,workspaceId
                                                                                    • name,workspaceCode
                                                                                      • ", "exampleSetFlag":false }, "ApiEntityPortfolioProgramInput":{ "title":"ApiEntityPortfolioProgramInput", "type":"object", "properties":{ "portfolioId":{ "type":"integer", "description":"The portfolio that includes the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioProgramId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide the value as DELETE if the program needs to be unlinked from portfolio. Not needed for linking.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityProgramFilterInput":{ "title":"ApiEntityProgramFilterInput", "type":"object", "properties":{ "fieldName":{ "type":"object", "description":"The program field on which the filter needs to be applied.
                                                                                      • The list of fields supported for filtering with String type are: spendEffectiveDate, actualFinish, actualStart, forecastFinishDate, forecastStartDate, plannedFinish, plannedStart, statusDate, businessImpact, updateDate, description, programCode, linkForecastToSpend, programName, problemOrOpportunity, status, strategicObjective, evaluationScore. In addition, filtering is also possible on the following non-API exposed program fields: createDate and strategyProgramAlignScore.
                                                                                      • The ConfiguredFieldIdentifier type is used for filtering program configured fields.
                                                                                      • The CodeTypeIdentifier type is used for filtering program code types.
                                                                                      ", "exampleSetFlag":false, "oneOf":[ { "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, { "$ref":"#/components/schemas/ConfiguredFieldIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/CodeTypeIdentifier", "exampleSetFlag":false } ] }, "operator":{ "type":"string", "description":"Equality condition.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EQUALS", "NOT_EQUALS", "EQUALS_IGNORE_CASE", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "IN", "NOT_IN", "STARTS_WITH", "ENDS_WITH", "LIKE", "NOT_LIKE", "BETWEEN", "NOT_BETWEEN", "IS_NULL", "NOT_NULL", "IS_EMPTY", "IS_UNDER" ] }, "fieldValue":{ "type":"object", "description":"Field value for filtering.
                                                                                      • ApiEntityDateFilter type is for performing filtering on any date fields, such as when the fieldName is provided with any dates.
                                                                                      • The CodeValueIdentifier type is for performing filtering on program code types i.e. when the fieldName is provided with the CodeTypeIdentifier value
                                                                                      • The String type value is for any other fields other than the ones mentioned already.
                                                                                      ", "exampleSetFlag":false, "oneOf":[ { "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, { "$ref":"#/components/schemas/CodeValueIdentifier", "exampleSetFlag":false }, { "$ref":"#/components/schemas/ApiEntityDateFilter", "exampleSetFlag":false } ] }, "join":{ "type":"string", "description":"Join condition", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "AND", "OR", "NULL" ] } }, "exampleSetFlag":false }, "ApiEntityPermissionSets":{ "title":"ApiEntityPermissionSets", "type":"object", "properties":{ "file":{ "type":"array", "description":"File permission sets.
                                                                                      Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfile", "exampleSetFlag":false }, "types":[ "array" ] }, "portfolio":{ "type":"array", "description":"Portfolio permission sets.
                                                                                      Applicable for workspace, portfolio retrieve APIs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfile", "exampleSetFlag":false }, "types":[ "array" ] }, "customLog":{ "type":"array", "description":"Custom log permission sets.
                                                                                      Applicable for workspace, project, program, customLogTypeObject retrieve APIs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfile", "exampleSetFlag":false }, "types":[ "array" ] }, "globalPermissions":{ "type":"array", "description":"Global permission sets.
                                                                                      Applicable for globalPermissions retrieve API.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfile", "exampleSetFlag":false }, "types":[ "array" ] }, "workspace":{ "type":"array", "description":"Workspace permission sets.
                                                                                      Applicable for workspace retrieve API.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfile", "exampleSetFlag":false }, "types":[ "array" ] }, "project":{ "type":"array", "description":"Project permission sets.
                                                                                      Applicable for workspace, project retrieve APIs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfile", "exampleSetFlag":false }, "types":[ "array" ] }, "report":{ "type":"array", "description":"Report permission sets.
                                                                                      Applicable for workspace, project, program, portfolio, report retrieve APIs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfile", "exampleSetFlag":false }, "types":[ "array" ] }, "program":{ "type":"array", "description":"Program permission sets.
                                                                                      Applicable for workspace, program retrieve APIs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfile", "exampleSetFlag":false }, "types":[ "array" ] }, "idea":{ "type":"array", "description":"Idea permission sets.
                                                                                      Applicable for workspace, idea retrieve APIs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfile", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityProfile":{ "title":"ApiEntityProfile", "type":"object", "properties":{ "description":{ "maxLength":4000, "type":"string", "description":"Description.", "exampleSetFlag":false, "types":[ "string" ] }, "profileName":{ "maxLength":255, "type":"string", "description":"Profile Name.", "exampleSetFlag":false, "types":[ "string" ] }, "profileId":{ "maxLength":255, "type":"string", "description":"Profile ID.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueProject":{ "title":"ApiEntityCodeValueProject", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueProjectId":{ "type":"integer", "description":"The unique identifier of the workspace where the code value was created. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProject":{ "title":"ApiEntityProject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "currentApprovedStartDate":{ "type":"string", "description":"The start date for the Current Approved Budget set by the budget planner.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "currentApprovedFinishDate":{ "type":"string", "description":"The finish date for the Current Approved Budget set by the budget planner.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "reportCycleNamingBoundary":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ] }, "noPredecessorActivityCount":{ "type":"integer", "description":"The number of activities in the project without predecessors.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "noSuccessorActivityCount":{ "type":"integer", "description":"The number of activities in the project without successors.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "danglingStartActivityCount":{ "type":"integer", "description":"The number of activities in the project that only have Start-to-Finish or Finish-to-Finish predecessor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Start-to-Start predecessor; No Start-to-Start successor; No Start-to-Finish successor; No Finish-to-Start predecessor. If the activity type is Milestone, the activity is not counted.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "danglingFinishActivityCount":{ "type":"integer", "description":"The number of activities in the project that only have Start-to-Finish or Start-to-Start successor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Finish-to-Finish predecessor; No Finish-to-Finish successor; No Start-to-Finish predecessor; No Finish-to-Start successor. If the activity type is Milestone, the activity is not counted.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "predecessorNegativeLagActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a lag less than 0.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "predecessorLagActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a lag greater than 0.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "fsPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Finish-to-Start (FS).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ssPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Start-to-Start (SS).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ffPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Finish-to-Finish (FF).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "sfPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Start-to-Finish (SF).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "hardConstraintActivityCount":{ "type":"integer", "description":"The number of activities in the project with a primary constraint of Mandatory Start or Mandatory Finish.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "softConstraintActivityCount":{ "type":"integer", "description":"The number of activities in the project with a primary constraint of As Late As Possible, Finish On, Finish On or After, Finish On or Before, Start On, Start On or After, or Start On or Before.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "negativeFloatActivityCount":{ "type":"integer", "description":"The number of activities in the project with a total float less than 0.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "largeDurationActivityCount":{ "type":"integer", "description":"The number of activities in the project with an Activity Remaining Duration that meets or exceeds the given criteria value. The default value is 320h.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "invalidProgressDateActivityCount":{ "type":"integer", "description":"The number of activities in the project with invalid progress. An activity is included in the count if any of the following are true: Activity Planned Start less than Data Date unless Activity has Actual Start; Activity Planned Finish less than or equal to Data Date and Activity is Not Started; Activity Actual Start greater than or equal to Data Date; Activity Actual Finish greater than Data Date.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "noPredecessorActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without predecessors.", "format":"double", "exampleSetFlag":false }, "noSuccessorActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without successors.", "format":"double", "exampleSetFlag":false }, "danglingStartActivityPercent":{ "type":"number", "description":"The percentage of activities in the project that only have Start-to-Finish or Finish-to-Finish predecessor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Start-to-Start predecessor; No Start-to-Start successor; No Start-to-Finish successor; No Finish-to-Start predecessor. If the activity type is Milestone, the activity is not counted.", "format":"double", "exampleSetFlag":false }, "danglingFinishActivityPercent":{ "type":"number", "description":"The percentage of activities in the project that only have Start-to-Finish or Start-to-Start successor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Finish-to-Finish predecessor; No Finish-to-Finish successor; No Start-to-Finish predecessor; No Finish-to-Start successor. If the activity type is Milestone, the activity is not counted.", "format":"double", "exampleSetFlag":false }, "predecessorNegativeLagActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a lag less than 0.", "format":"double", "exampleSetFlag":false }, "predecessorLagActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a lag greater than 0.", "format":"double", "exampleSetFlag":false }, "fsPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Finish-to-Start (FS).", "format":"double", "exampleSetFlag":false }, "ssPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Start-to-Start (SS).", "format":"double", "exampleSetFlag":false }, "ffPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Finish-to-Finish (FF).", "format":"double", "exampleSetFlag":false }, "sfPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Start-to-Finish (SF).", "format":"double", "exampleSetFlag":false }, "hardConstraintActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with a primary constraint of Mandatory Start or Mandatory Finish.", "format":"double", "exampleSetFlag":false }, "softConstraintActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with a primary constraint of As Late As Possible, Finish On, Finish On or After, Finish On or Before, Start On, Start On or After, or Start On or Before.", "format":"double", "exampleSetFlag":false }, "largeFloatActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with an Activity Total Float that meets or exceeds the given criteria value. The default value is 320h.", "format":"double", "exampleSetFlag":false }, "negativeFloatActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with a total float less than 0.", "format":"double", "exampleSetFlag":false }, "largeDurationActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with an Activity Remaining Duration that meets or exceeds the given criteria value. The default value is 320h.", "format":"double", "exampleSetFlag":false }, "noResourceActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without role or resource assignments.", "format":"double", "exampleSetFlag":false }, "invalidProgressDateActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with invalid progress. An activity is included in the count if any of the following are true: Activity Planned Start less than Data Date; Activity Planned Finish less than or equal to Data Date; Activity Actual Start greater than or equal to Data Date; Activity Actual Finish greater than Data Date.", "format":"double", "exampleSetFlag":false }, "projectScheduleHealthPercent":{ "type":"number", "description":"The weighted aggregation of active check values that represents the overall quality of your project. A higher schedule health score indicates a higher quality schedule. Calculated as 100% - (Sum of [Check Adjusted Percentage * Check Weighting] / Sum of all active check weighting values)", "format":"double", "exampleSetFlag":false }, "percentCompleteWeightedBy":{ "type":"string", "description":"The weight for scope items is calculated using quantity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COST", "QUANTITY", "HOURS", "MANUAL" ] }, "breakdownCapitalForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectIntegrationSourceDetails":{ "description":"The integration source details associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectIntegrationSource" } ] }, "lastProjectEvaluationDate":{ "type":"string", "description":"The date on which the project was last evaluated. ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "copyFromProjectId":{ "type":"integer", "description":"Deprecated. As of 26.1.
                                                                                      The system-generated unique identifier of the project or project template from which the new project needs to be copied from.", "format":"int64", "deprecated":true, "exampleSetFlag":false, "types":[ "integer" ] }, "copyCustomLogTypes":{ "type":"array", "description":"Name of custom log types from the project or project template to be copied to create a new project.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "codeValuesProject":{ "type":"array", "description":"The list of code values for a project. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProject", "exampleSetFlag":false }, "types":[ "array" ] }, "projectFinancial":{ "description":"The financial fields associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectFinancial" } ] }, "projectAutoNumber":{ "type":"array", "description":"The autonumber settings of a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectAutoNumber", "exampleSetFlag":false }, "types":[ "array" ] }, "projectTerm":{ "type":"string", "description":"Project termination date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "copyOptions":{ "type":"object", "description":"Deprecated. As of 26.1.

                                                                                      The copy options map controls which features are copied when creating a new project from an existing project or project template. Each entry uses a feature name as the key and a boolean value (true or false) to determine whether the corresponding feature is included in the new project. Features not specified or explicitly set to false are excluded from the copy operation.

                                                                                      \nMap Keys (Allowed Values):\n
                                                                                        \n
                                                                                      • ACTIVITY
                                                                                        • \n
                                                                                      • RELATIONSHIP
                                                                                        • \n
                                                                                      • RESOURCE
                                                                                        • \n
                                                                                      • ROLE
                                                                                        • \n
                                                                                      • ASSIGNMENT
                                                                                        • \n
                                                                                      • TASK
                                                                                        • \n
                                                                                      • TASK_HANDOFFS
                                                                                        • \n
                                                                                      • RISK
                                                                                        • \n
                                                                                      • MATRIX
                                                                                        • \n
                                                                                      • ACTIVITY_UNCERTAINTY
                                                                                        • \n
                                                                                      • WBS
                                                                                        • \n
                                                                                      • AUTO_NUMBERING
                                                                                        • \n
                                                                                      • MANAGER
                                                                                        • \n
                                                                                      • PROJECT_SETTINGS
                                                                                        • \n
                                                                                      • CALENDAR
                                                                                        • \n
                                                                                      • UOM
                                                                                        • \n
                                                                                      • MONTECARLO_SETTING
                                                                                        • \n
                                                                                      • CUSTOM_LOG
                                                                                        • \n
                                                                                      • PROJECT_CODE
                                                                                        • \n
                                                                                      • PROJECT_CALENDAR
                                                                                        • \n
                                                                                      • COPY_ACTUALS
                                                                                        • \n
                                                                                      \nExample:\n
                                                                                      { \"ACTIVITY\": true, \"RESOURCE\": true }
                                                                                      \n

                                                                                      Note: To copy either \"RESOURCE\" or \"ROLE\", both options must be set to true.

                                                                                      \n
                                                                                      \nCOPY_ACTUALS Option and Group Dependencies\n

                                                                                      The COPY_ACTUALS option enables copying of actuals data (project progress data) for supported features. When COPY_ACTUALS is set to true, certain features are grouped together for dependency management.

                                                                                      \nFeature groups:\n
                                                                                        \n
                                                                                      • Schedule Actuals Group: ACTIVITY, RELATIONSHIP, ASSIGNMENT
                                                                                        • \n
                                                                                      • Resource Actuals Group: RESOURCE, ROLE
                                                                                        • \n
                                                                                      • Risk Actuals Group: RISK, MATRIX, ACTIVITY_UNCERTAINTY
                                                                                        • \n
                                                                                      • Task Actuals Group: TASK, TASK_HANDOFFS
                                                                                        • \n
                                                                                      \nDependency rules when COPY_ACTUALS is true:\n
                                                                                        \n
                                                                                      • If any member of a group is included and COPY_ACTUALS is true, all features in that group are automatically set to true by the system, regardless of whether they were specified or set to false in the input map.
                                                                                        • \n
                                                                                      • Inclusion of any feature within the Risk Actuals Group results in all members of the Schedule Actuals Group also being copied, ensuring consistency and completeness of the actuals data.
                                                                                        • \n
                                                                                      \nExamples:\n
                                                                                        \n
                                                                                      • With { \"TASK\": true, \"COPY_ACTUALS\": true }, both TASK and TASK_HANDOFFS will be copied.
                                                                                        • \n
                                                                                      • With { \"RISK\": true, \"COPY_ACTUALS\": true }, the following features will be copied: RISK, MATRIX, ACTIVITY_UNCERTAINTY, ACTIVITY, RELATIONSHIP, and ASSIGNMENT.
                                                                                        • \n
                                                                                      \n

                                                                                      When COPY_ACTUALS is not enabled, only the features explicitly set to true are copied, and no automatic group expansion occurs.

                                                                                      ", "deprecated":true, "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_RESOURCE_DOCUMENT_KEY:project_resource_copyOptions_description" } }, "parentProject":{ "type":"integer", "description":"The workspace the project is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "priorityNum":{ "maximum":10000, "minimum":1, "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "primaryProgramCode":{ "maxLength":60, "type":"string", "description":"The user-defined identifier of a primary program of a project. This field is intended to be used while updating a project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStartDate":{ "type":"string", "description":"The earliest possible date the remaining work for the activity is scheduled to begin. This date is calculated by the project scheduler but can be updated manually by the user. Before the activity is started, the Remaining Start is the same as the Project Planned Start. Once the activity has started, the Remaining Start is equal to the Data Date. When the activity is complete, the Remaining Start is blank.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinishDate":{ "type":"string", "description":"The earliest possible date the remaining work for the activity is scheduled to finish. This date is calculated by the project scheduler but can be updated manually by the user. Before the activity is started, the Remaining Finish is the same as the Planned Finish. When the activity is complete, the Remaining Finish is blank.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "recordCount":{ "type":"integer", "description":"The number of comments on a project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "securityGuid":{ "maxLength":32, "type":"string", "description":"Globally unique identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "scheduledFinishDate":{ "type":"string", "description":"The calculated latest early finish date, which is based on the schedule most recently generated for the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The Actual Start indicates the date work on the project began.
                                                                                      This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The Actual Finish displays the date on which a project is considered complete.
                                                                                      This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastFinishDate":{ "type":"string", "description":"The planned finish date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastStartDate":{ "type":"string", "description":"The planned start date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendStartDate":{ "type":"string", "description":"The start date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendFinishDate":{ "type":"string", "description":"The finish date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsStartDate":{ "type":"string", "description":"The date benefits on the project began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsFinishDate":{ "type":"string", "description":"The date benefits on the project finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationScore":{ "type":"number", "description":"The quantitative score of a project based on the qualitative ranking of projects against different evaluation categories. This value is used by portfolio managers to prioritize projects.", "format":"double", "exampleSetFlag":false }, "spendEffectiveDate":{ "type":"string", "description":"The month in which an actuals value was last added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastToSpend":{ "type":"boolean", "description":"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.", "exampleSetFlag":false, "types":[ "boolean" ] }, "forecastLinkType":{ "type":"string", "description":"The type of forecast data linked to a project. Forecast data represents an estimation of a project's remaining costs.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "INTEGRATION" ] }, "plannedBudgetLinkType":{ "type":"string", "description":"Type of data to which a project's planned budget is linked.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "BUDGET", "INTEGRATION" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The estimated percentage of work that has been completed on the project. This value is entered by the user.", "format":"double", "exampleSetFlag":false }, "riskMatrixId":{ "type":"integer", "description":"The risk matrix assigned to the project for calculating project risk scores.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reportCycleId":{ "type":"integer", "description":"The reporting cycle assigned to the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCashFlows":{ "type":"array", "description":"The cash flow of a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCashFlow", "exampleSetFlag":false }, "types":[ "array" ] }, "primaryProgramId":{ "type":"integer", "description":"The system-generated identifier of a primary program of a project. This field is intended to be used while updating a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskAnalysisJobStatus":{ "type":"string", "description":"The status of the most recent risk analysis service.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_RAN_YET", "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ] }, "riskAnalysisStartDate":{ "type":"string", "description":"The start time of the most recent risk analysis service.", "format":"date-time", "exampleSetFlag":false }, "riskAnalysisFinishDate":{ "type":"string", "description":"The finish time of the most recent risk analysis service.", "format":"date-time", "exampleSetFlag":false }, "riskAnalysisDuration":{ "type":"number", "description":"The duration of the most recent risk analysis service.", "format":"double", "exampleSetFlag":false }, "actualLinkType":{ "type":"string", "description":"Type of actuals data linked to a project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "ACTUAL", "INTEGRATION" ] }, "projectSettings":{ "type":"array", "description":"The project settings associated with the project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "planEndDate":{ "type":"string", "description":"The finish date for the time phased Planned Budget of the project.
                                                                                      Planned Budget cost spread will adjust when this date is changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planStartDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "websiteUrl":{ "maxLength":200, "minLength":0, "type":"string", "description":"The link to a website related to the project.", "exampleSetFlag":false, "types":[ "string" ] }, "dataDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planDuration":{ "type":"number", "description":"The duration between Project Planned Start and Project Planned Finish.
                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "startDateVariance":{ "type":"number", "description":"The duration between the project's start date and the baseline's start date.
                                                                                      When the field value is generated through a P6 EPPM connection, then it represents the duration between the start date in the current project and the baseline start date.
                                                                                      This value can only be imported.", "format":"double", "exampleSetFlag":false }, "finishDateVariance":{ "type":"number", "description":"The duration between the project's finish date and the baseline's finish date.
                                                                                      When the field value is generated through a P6 EPPM connection, then it represents the duration between the finish date in the current project and the baseline finish date.
                                                                                      This value can only be imported.", "format":"double", "exampleSetFlag":false }, "strgyPriorityNum":{ "maximum":10000, "minimum":1, "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "mustFinishByDate":{ "type":"string", "description":"The latest date on which the scheduled activities must be complete for a project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkPlannedBudgetTo":{ "type":"integer", "description":"Specifies data to which a project planned budget is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linkForecastTo":{ "type":"integer", "description":"Specifies data to which a project forecast is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linkActualTo":{ "type":"integer", "description":"Specifies data to which project actuals data is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isTemplateFlag":{ "type":"boolean", "description":"Indicates the project is a template for creating other projects.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exchangeRate":{ "type":"number", "description":"The custom exchange rate for the currency assigned to the project.", "exampleSetFlag":false, "types":[ "number" ] }, "projectIntegrationType":{ "type":"string", "description":"Specifies if the project is integrated with another application.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "P6", "UNIFIER" ] }, "riskLevel":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ] }, "riskScore":{ "type":"integer", "description":"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.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectTimeZone":{ "type":"string", "description":"The time zone of the project's location.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "INTERNATIONAL_DATE_LINE_WEST", "MIDWAY_ISLAND_SAMOA", "HAWAII", "ALASKA", "PACIFIC_TIME", "ARIZONA", "CHIHUAHUA_LA_PAZ_MAZATLAN", "MOUNTAIN_TIME", "CENTRAL_AMERICA", "CENTRAL_TIME", "GUADALAJARA_MEXICO_CITY_MONTERREY", "SASKATCHEWAN", "BOGOTA_LIMA_QUITO", "EASTERN_TIME", "INDIANA", "ATLANTIC_TIME", "CARACAS_LA_PAZ_PUERTO_RICO", "SANTIAGO", "NEWFOUNDLAND", "BRASILIA", "BUENOS_AIRES_GEORGETOWN", "MID_ATLANTIC", "AZORES", "CAPE_VERDE_IS", "CASABLANCA_MONROVIA", "GREENWICH_MEAN_TIME", "AMSTERDAM_BERLIN_BERN", "BELGRADE_BRATISLAVA_BUDAPEST", "BRUSSELS_COPENHAGEN_MADRID", "SARAJEVO_SKOPJE_WARSAW", "WEST_CENTRAL_AFRICA", "ATHENS_BEIRUT_ISTANBUL", "BUCHAREST", "CAIRO", "HARARE_PRETORIA", "HELSINKI_KVIV_RIGA", "JERUSALEM", "BAGHDAD", "KUWAIT_RIYADH", "NAIROBI", "MOSCOW_ST_PETERSBURG", "TEHRAN", "ABU_DHADI_MUSCAT", "BAKU_TBILISI_YEREVAN", "KABUL", "ISLAMABAD_KARACHI_TASHKENT", "CHENNAI_KOLKATA_MUMBAI", "ASTANA_DHAKA", "RANGOON", "BANGKOK_HANOI_JAKARTA", "BEJING_CHONGQING_HONG_KONG", "KUALA_LUMPUR_SINGAPORE", "PERTH", "TAIPEI", "OSAKA_SAPPORO_TOKYO", "SEOUL", "ADELAIDE", "DARWIN", "BRISBANE", "CANBERRA_MELBOURNE_SYDNEY", "GUAM_PORT_MORESBY", "HOBART", "MAGADAN_SOLOMON_IS_NEW_CALEDONIA", "AUCKLAND_WELLINGTON" ] }, "projectCurrency":{ "type":"integer", "description":"The unique identifier of the currency to be used in the project. Currencies configured in the immediate parent workspace, with at least one exchange rate configured, are available to be used in the project. If no value is specified, the parent workspace currency will be selected.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "openEndsActivityCount":{ "type":"integer", "description":"The number of activities in the project without predecessors or successors.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "largeFloatActivityCount":{ "type":"integer", "description":"The number of activities in the project with an Activity Total Float that meets or exceeds the given criteria value. The default value is 320h.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "noResourceActivityCount":{ "type":"integer", "description":"The number of activities in the project without role or resource assignments.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "lateActivityCount":{ "type":"integer", "description":"The number of activities in the project with an Activity Baseline Finish Variance less than 0 or without a set activity baseline.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "totalActivityCount":{ "type":"integer", "description":"The total number of activities in the project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "openEndsActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without predecessors or successors.", "format":"double", "exampleSetFlag":false }, "lateActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with an Activity Baseline Finish Variance less than 0 or without a set activity baseline.", "format":"double", "exampleSetFlag":false }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of appearance of projects in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "managerId":{ "type":"integer", "description":"The user id of a manager or person responsible for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationMatrixId":{ "type":"integer", "description":"The evaluation matrix of a calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of a project in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The date on which work on the project starts.
                                                                                      This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The date on which all project work is complete.
                                                                                      This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The duration between the Project Start and Project Finish.
                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualDuration":{ "type":"number", "description":"The Actual Duration represents the total working time between the project Actual Start and Actual Finish for a project.
                                                                                      This value can be imported. The Actual Duration field is not editable.", "format":"double", "exampleSetFlag":false }, "proposedStartDate":{ "type":"string", "description":"The start date for the Proposed Budget of the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedFinishDate":{ "type":"string", "description":"The finish date for the Proposed Budget of the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "locationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                      This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                      This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "minLength":0, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manager":{ "maxLength":255, "type":"string", "description":"The user name of a manager or person responsible for the project.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETE" ] }, "image":{ "description":"The image associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectImage" } ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectAutoNumber":{ "title":"ApiEntityProjectAutoNumber", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "prefix":{ "maxLength":20, "type":"string", "description":"The initial characters for the auto numbering sequence.", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":50, "type":"string", "description":"This is an internal field.", "exampleSetFlag":false, "types":[ "string" ] }, "increment":{ "type":"integer", "description":"The number to increment the starting number by.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectAutoNumberId":{ "type":"integer", "description":"The auto generated ID for the object. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "suffix":{ "maxLength":40, "type":"string", "description":"The first number in the auto numbering sequence.", "exampleSetFlag":false, "types":[ "string" ] }, "area":{ "type":"string", "description":"Identifies the type of object used for auto numbering.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IDEA", "PROGRAM", "PROJECT", "ACTIVITY", "SCHEDULE_SCENARIO", "ACTIVITY_ASSIGNMENT", "WBS", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGE", "PROGRAM_BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "PROG_RISK", "ACTUALS", "WORK_MANAGER_TASK", "CONSTRAINT", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM", "RESOURCE", "RISK_MITIGATION", "PROGRAM_RISK_MITIGATION" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectCashFlow":{ "title":"ApiEntityProjectCashFlow", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "year":{ "type":"integer", "description":"The time period during which budget planning for the project takes place in years.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "month":{ "type":"integer", "description":"The time period during which budget planning for the project takes place in months.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "currentApprovedBudgetCapitalCostWorkspace1":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostWorkspace2":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostWorkspace3":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostWorkspace1":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostWorkspace2":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostWorkspace3":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace2":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace3":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals. This value is based on the base currency with specified exchange rate. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals. This value is based on the base currency with specified exchange rate. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals. This value is based on the base currency with specified exchange rate. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVarWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Approved Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVarWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Approved Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVarWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Approved Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedForecastVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedForecastVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedForecastVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVarWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVarWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVarWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetWorkspace1":{ "type":"number", "description":"The budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetWorkspace2":{ "type":"number", "description":"The budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetWorkspace3":{ "type":"number", "description":"The budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetProject":{ "type":"number", "description":"The approved time phased budget currently allocated to the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the capital planner.
                                                                                      A Proposed Budget becomes a Current Approved Budget after the capital plan scenario has undergone the approval process. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostProject":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostProject":{ "type":"number", "description":"The time phased estimation of a project's remaining capital costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostProject":{ "type":"number", "description":"The time phased estimation of a project's remaining expense costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostProject":{ "type":"number", "description":"The time phased actual capital spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostProject":{ "type":"number", "description":"The time phased actual expense spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalProject":{ "type":"number", "description":"The planned time phased capital cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseProject":{ "type":"number", "description":"The planned time phased expense cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCost":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostProject":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCost":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostProject":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCost":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostProject":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCost":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostProject":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace1":{ "type":"number", "description":"The planned time phased capital cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace2":{ "type":"number", "description":"The planned time phased capital cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace3":{ "type":"number", "description":"The planned time phased capital cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace1":{ "type":"number", "description":"The planned time phased expense cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace2":{ "type":"number", "description":"The planned time phased expense cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace3":{ "type":"number", "description":"The planned time phased expense cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostWorkspace1":{ "type":"number", "description":"The time phased actual capital spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostWorkspace2":{ "type":"number", "description":"The time phased actual capital spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostWorkspace3":{ "type":"number", "description":"The time phased actual capital spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostWorkspace1":{ "type":"number", "description":"The time phased actual expense spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostWorkspace2":{ "type":"number", "description":"The time phased actual expense spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostWorkspace3":{ "type":"number", "description":"The time phased actual expense spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace1":{ "type":"number", "description":"The time phased estimation of a project's remaining capital costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace2":{ "type":"number", "description":"The time phased estimation of a project's remaining capital costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace3":{ "type":"number", "description":"The time phased estimation of a project's remaining capital costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace1":{ "type":"number", "description":"The time phased estimation of a project's remaining expense costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace2":{ "type":"number", "description":"The time phased estimation of a project's remaining expense costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace3":{ "type":"number", "description":"The time phased estimation of a project's remaining expense costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetWorkspace1":{ "type":"number", "description":"The time phased Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own Planned Budgets and project Forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Becomes the projects Current Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetWorkspace2":{ "type":"number", "description":"The time phased Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own Planned Budgets and project Forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Becomes the projects Current Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetWorkspace3":{ "type":"number", "description":"The time phased Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own Planned Budgets and project Forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Becomes the projects Current Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostWorkspace1":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostWorkspace2":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostWorkspace3":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostWorkspace1":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostWorkspace2":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostWorkspace3":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualForecastVarWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualForecastVarWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualForecastVarWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace1":{ "type":"number", "description":"Calculated as the sum of the Actual Costs plus Remaining Costs for the project.
                                                                                      You can copy the values of At Completion into the project's Forecast to accurately track the time phased costs of the project.
                                                                                      At Completion data is only available when the application is connected to P6 EPPM and is not editable.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace2":{ "type":"number", "description":"Calculated as the sum of the Actual Costs plus Remaining Costs for the project.
                                                                                      You can copy the values of At Completion into the project's Forecast to accurately track the time phased costs of the project.
                                                                                      At Completion data is only available when the application is connected to P6 EPPM and is not editable.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace3":{ "type":"number", "description":"Calculated as the sum of the Actual Costs plus Remaining Costs for the project.
                                                                                      You can copy the values of At Completion into the project's Forecast to accurately track the time phased costs of the project.
                                                                                      At Completion data is only available when the application is connected to P6 EPPM and is not editable.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace1":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualForecastVarProject":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceProject":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVarProject":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVarProject":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Current Approved Budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVariance":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals.This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVarianceProject":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedForecastVariance":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedForecastVarianceProject":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsProject":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVar":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVar":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Current Approved Budget. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualForecastVar":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostProject":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCost":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable.", "format":"double", "exampleSetFlag":false }, "benefits":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendPlannedVariance":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "projectPhaseFinancialId":{ "type":"integer", "description":"The unique internal identifier for the project's time-phased cost spread. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "spreadDate":{ "type":"string", "description":"The starting date for a time phase of the project life cycle.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastCost":{ "type":"number", "description":"The time phased estimation of a project's remaining costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCostProject":{ "type":"number", "description":"The time phased estimation of a project's remaining costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudget":{ "type":"number", "description":"The planned time phased cost of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetProject":{ "type":"number", "description":"The planned time phased cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudget":{ "type":"number", "description":"The approved time phased budget currently allocated to the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the capital planner.
                                                                                      A Proposed Budget becomes a Current Approved Budget after the capital plan scenario has undergone the approval process. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudget":{ "type":"number", "description":"The time phased Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own Planned Budgets and project Forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Becomes the projects Current Approved Budget after the portfolio budget plan scenario is approved. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetProject":{ "type":"number", "description":"The time phased Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own Planned Budgets and project Forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Becomes the projects Current Approved Budget after the portfolio budget plan scenario is approved. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCost":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "ytdActualCost":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "ytdActualCostProject":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "spendCost":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendCostProject":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCost":{ "type":"number", "description":"The time phased estimation of a project's remaining capital costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCost":{ "type":"number", "description":"The time phased estimation of a project's remaining expense costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCost":{ "type":"number", "description":"The time phased actual capital spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCost":{ "type":"number", "description":"The time phased actual expense spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapital":{ "type":"number", "description":"The planned time phased capital cost of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpense":{ "type":"number", "description":"The planned time phased expense cost of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace1":{ "type":"number", "description":"The planned time phased cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace2":{ "type":"number", "description":"The planned time phased cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace3":{ "type":"number", "description":"The planned time phased cost in project currency of a project as defined by the project manager.
                                                                                      Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostWorkspace1":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostWorkspace2":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostWorkspace3":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace1":{ "type":"number", "description":"The time phased estimation of a project's remaining costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace2":{ "type":"number", "description":"The time phased estimation of a project's remaining costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace3":{ "type":"number", "description":"The time phased estimation of a project's remaining costs.
                                                                                      After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                      Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"Calculated as the sum of the Actual Costs plus Remaining Costs for the project.
                                                                                      You can copy the values of At Completion into the project's Forecast to accurately track the time phased costs of the project.
                                                                                      At Completion data is only available when the application is connected to P6 EPPM and is not editable.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "ytdActualCostWorkspace1":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "ytdActualCostWorkspace2":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "ytdActualCostWorkspace3":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace1":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace2":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace3":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace1":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace2":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace3":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "atCompletionCost":{ "type":"number", "description":"Calculated as the sum of the Actual Costs plus Remaining Costs for the project.
                                                                                      You can copy the values of At Completion into the project's Forecast to accurately track the time phased costs of the project.
                                                                                      At Completion data is only available when the application is connected to P6 EPPM and is not editable.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectConfiguredFieldValue":{ "title":"ApiEntityProjectConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Project Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier for an Project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectFinancial":{ "title":"ApiEntityProjectFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "currentApprovedBudgetBasePresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseUndistributedWorkspace1":{ "type":"number", "description":"The amount of proposed budget unallocated across the project timescale.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseUndistributedWorkspace2":{ "type":"number", "description":"The amount of proposed budget unallocated across the project timescale.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseUndistributedWorkspace3":{ "type":"number", "description":"The amount of proposed budget unallocated across the project timescale.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseDistributedWorkspace1":{ "type":"number", "description":"The amount of approved budget currently allocated across the project timescale.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseDistributedWorkspace2":{ "type":"number", "description":"The amount of approved budget currently allocated across the project timescale.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseDistributedWorkspace3":{ "type":"number", "description":"The amount of approved budget currently allocated across the project timescale.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseUndistributedWorkspace1":{ "type":"number", "description":"The amount of approved budget unallocated across the project timescale.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseUndistributedWorkspace2":{ "type":"number", "description":"The amount of approved budget unallocated across the project timescale.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseUndistributedWorkspace3":{ "type":"number", "description":"The amount of approved budget unallocated across the project timescale.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBasePresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBasePresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBasePresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostPresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostPresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostPresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of approved budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of approved budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of approved budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostUnDistributedWorkspace1":{ "type":"number", "description":"The capital amount of approved budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostUnDistributedWorkspace2":{ "type":"number", "description":"The capital amount of approved budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostUnDistributedWorkspace3":{ "type":"number", "description":"The capital amount of approved budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostDistributedWorkspace1":{ "type":"number", "description":"The expense amount of approved budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostDistributedWorkspace2":{ "type":"number", "description":"The expense amount of approved budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostDistributedWorkspace3":{ "type":"number", "description":"The expense amount of approved budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostUnDistributedWorkspace1":{ "type":"number", "description":"The expense amount of approved budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostUnDistributedWorkspace2":{ "type":"number", "description":"The expense amount of approved budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostUnDistributedWorkspace3":{ "type":"number", "description":"The expense amount of approved budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBasePresentValueProject":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseDistributedProject":{ "type":"number", "description":"The amount of approved budget currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseUndistributedProject":{ "type":"number", "description":"The amount of approved budget unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundApprovedBudgetVarianceProject":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Approved Budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundPlannedBudgetVarianceProject":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Planned Budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBasePresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBasePresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUnDistributedProject":{ "type":"number", "description":"The capital amount of planned budget unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUnDistributedProject":{ "type":"number", "description":"The expense amount of planned budget unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostPresentValueProject":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostPresentValueProject":{ "type":"number", "description":"The expense present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostDistributedProject":{ "type":"number", "description":"The capital amount of proposed budget currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostUnDistributedProject":{ "type":"number", "description":"The capital amount of proposed budget unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostDistributedProject":{ "type":"number", "description":"The expense amount of proposed budget currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostUnDistributedProject":{ "type":"number", "description":"The expense amount of proposed budget unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostPresentValue":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostPresentValueProject":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostPresentValue":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostPresentValueProject":{ "type":"number", "description":"The expense present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostDistributed":{ "type":"number", "description":"The capital amount of approved budget currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostDistributedProject":{ "type":"number", "description":"The capital amount of approved budget currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostUnDistributed":{ "type":"number", "description":"The capital amount of approved budget unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostUnDistributedProject":{ "type":"number", "description":"The capital amount of approved budget unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostDistributed":{ "type":"number", "description":"The expense amount of approved budget currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostDistributedProject":{ "type":"number", "description":"The expense amount of approved budget currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostUnDistributed":{ "type":"number", "description":"The expense amount of approved budget unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostUnDistributedProject":{ "type":"number", "description":"The expense amount of approved budget unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUnDistributedWorkspace1":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUnDistributedWorkspace2":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUnDistributedWorkspace3":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUnDistributedWorkspace1":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUnDistributedWorkspace2":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUnDistributedWorkspace3":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUnDistributedWorkspace1":{ "type":"number", "description":"The capital amount of planned budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUnDistributedWorkspace2":{ "type":"number", "description":"The capital amount of planned budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUnDistributedWorkspace3":{ "type":"number", "description":"The capital amount of planned budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUnDistributedWorkspace1":{ "type":"number", "description":"The expense amount of planned budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUnDistributedWorkspace2":{ "type":"number", "description":"The expense amount of planned budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUnDistributedWorkspace3":{ "type":"number", "description":"The expense amount of planned budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUnDistributedWorkspace1":{ "type":"number", "description":"The capital amount of project actuals unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUnDistributedWorkspace2":{ "type":"number", "description":"The capital amount of project actuals unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUnDistributedWorkspace3":{ "type":"number", "description":"The capital amount of project actuals unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUnDistributedWorkspace1":{ "type":"number", "description":"The expense amount of project actuals unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUnDistributedWorkspace2":{ "type":"number", "description":"The expense amount of project actuals unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUnDistributedWorkspace3":{ "type":"number", "description":"The expense amount of project actuals unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostPresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostPresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostPresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of proposed budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of proposed budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of proposed budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostUnDistributedWorkspace1":{ "type":"number", "description":"The capital amount of proposed budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostUnDistributedWorkspace2":{ "type":"number", "description":"The capital amount of proposed budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostUnDistributedWorkspace3":{ "type":"number", "description":"The capital amount of proposed budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostDistributedWorkspace1":{ "type":"number", "description":"The expense amount of proposed budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostDistributedWorkspace2":{ "type":"number", "description":"The expense amount of proposed budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostDistributedWorkspace3":{ "type":"number", "description":"The expense amount of proposed budget currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostUnDistributedWorkspace1":{ "type":"number", "description":"The expense amount of proposed budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostUnDistributedWorkspace2":{ "type":"number", "description":"The expense amount of proposed budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostUnDistributedWorkspace3":{ "type":"number", "description":"The expense amount of proposed budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostWorkspace1":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostWorkspace2":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostWorkspace3":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostWorkspace1":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostWorkspace2":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostWorkspace3":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedWorkspace1":{ "type":"number", "description":"The capital amount of planned budget allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedWorkspace2":{ "type":"number", "description":"The capital amount of planned budget allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedWorkspace3":{ "type":"number", "description":"The capital amount of planned budget allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedWorkspace1":{ "type":"number", "description":"The expense amount of planned budget allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedWorkspace2":{ "type":"number", "description":"The expense amount of planned budget allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedWorkspace3":{ "type":"number", "description":"The expense amount of planned budget allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of forecast cost currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of forecast cost currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of forecast cost currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedWorkspace1":{ "type":"number", "description":"The expense amount of forecast cost currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedWorkspace2":{ "type":"number", "description":"The expense amount of forecast cost currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedWorkspace3":{ "type":"number", "description":"The expense amount of forecast cost currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundPlannedBudgetVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Planned Budget. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundPlannedBudgetVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Planned Budget. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundPlannedBudgetVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Planned Budget. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundApprovedBudgetVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Approved Budget. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundApprovedBudgetVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Approved Budget. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundApprovedBudgetVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Approved Budget. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBasePresentValue":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBasePresentValue":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio approved budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueProject":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueProject":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBasePresentValueProject":{ "type":"number", "description":"The present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueProject":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostProject":{ "type":"number", "description":"The expected total cost of the project when the defined scope of work will be completed.
                                                                                      This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostProject":{ "type":"number", "description":"The estimated cost needed to complete the project.
                                                                                      This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseDistributed":{ "type":"number", "description":"The amount of proposed budget currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseDistributedProject":{ "type":"number", "description":"The amount of proposed budget currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseUndistributed":{ "type":"number", "description":"The amount of proposed budget unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseUndistributedProject":{ "type":"number", "description":"The amount of proposed budget unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseDistributed":{ "type":"number", "description":"The amount of approved budget currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetBaseUndistributed":{ "type":"number", "description":"The amount of approved budget unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedProject":{ "type":"number", "description":"The amount of planned budget allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedProject":{ "type":"number", "description":"The amount of planned budget unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedProject":{ "type":"number", "description":"The amount of forecast cost currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundApprovedBudgetVariance":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Approved Budget. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "allocatedFundForecastVariance":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Forecast. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "allocatedFundForecastVarianceProject":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Forecast. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundPlannedBudgetVariance":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Planned Budget. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "budgetCurrentCostProject":{ "type":"number", "description":"The total cost of the project budget, including all transfers and changes. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "budgetCurrentCostWorkspace1":{ "type":"number", "description":"The total project budget cost of a workspace.", "format":"double", "exampleSetFlag":false }, "budgetCurrentCostWorkspace2":{ "type":"number", "description":"The total project budget cost of a workspace.", "format":"double", "exampleSetFlag":false }, "budgetCurrentCostWorkspace3":{ "type":"number", "description":"The total project budget cost of a workspace.", "format":"double", "exampleSetFlag":false }, "budgetOriginalCostProject":{ "type":"number", "description":"The total original cost of the project budget, before transfers and changes. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "budgetOriginalCostWorkspace1":{ "type":"number", "description":"The total original project budget cost of a workspace.", "format":"double", "exampleSetFlag":false }, "budgetOriginalCostWorkspace2":{ "type":"number", "description":"The total original project budget cost of a workspace.", "format":"double", "exampleSetFlag":false }, "budgetOriginalCostWorkspace3":{ "type":"number", "description":"The total original project budget cost of a workspace.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedProject":{ "type":"number", "description":"The amount of forecast cost unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseDistributedWorkspace1":{ "type":"number", "description":"The amount of proposed budget currently allocated across the project timescale.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseDistributedWorkspace2":{ "type":"number", "description":"The amount of proposed budget currently allocated across the project timescale.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseDistributedWorkspace3":{ "type":"number", "description":"The amount of proposed budget currently allocated across the project timescale.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace2":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace3":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals. This value is based on the base currency with specified exchange rate. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals. This value is based on the base currency with specified exchange rate. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals. This value is based on the base currency with specified exchange rate. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVarWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Approved Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVarWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Approved Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVarWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Approved Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedForecastVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedForecastVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedForecastVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVarWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVarWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVarWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the base currency with specified exchange rate.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetWorkspace1":{ "type":"number", "description":"The budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetWorkspace2":{ "type":"number", "description":"The budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetWorkspace3":{ "type":"number", "description":"The budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributed":{ "type":"number", "description":"The capital amount of project actuals currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributed":{ "type":"number", "description":"The expense amount of project actuals currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of project actuals currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedWorkspace1":{ "type":"number", "description":"The expense amount of project actuals currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of project actuals currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedWorkspace2":{ "type":"number", "description":"The expense amount of project actuals currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of project actuals currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedWorkspace3":{ "type":"number", "description":"The expense amount of project actuals currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetProject":{ "type":"number", "description":"The budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostProject":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostProject":{ "type":"number", "description":"The total capital estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostProject":{ "type":"number", "description":"The total expense estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostProject":{ "type":"number", "description":"Total capital costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostProject":{ "type":"number", "description":"Total expense costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalProject":{ "type":"number", "description":"The planned total capital cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseProject":{ "type":"number", "description":"The planned total expense cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCost":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetCapitalCostProject":{ "type":"number", "description":"The capital budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCost":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetExpenseCostProject":{ "type":"number", "description":"The expense budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCost":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostProject":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCost":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostProject":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace1":{ "type":"number", "description":"The planned total capital cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace2":{ "type":"number", "description":"The planned total capital cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace3":{ "type":"number", "description":"The planned total capital cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace1":{ "type":"number", "description":"The planned total expense cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace2":{ "type":"number", "description":"The planned total expense cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace3":{ "type":"number", "description":"The planned total expense cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostWorkspace1":{ "type":"number", "description":"Total capital costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostWorkspace2":{ "type":"number", "description":"Total capital costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostWorkspace3":{ "type":"number", "description":"Total capital costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostWorkspace1":{ "type":"number", "description":"Total expense costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostWorkspace2":{ "type":"number", "description":"Total expense costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostWorkspace3":{ "type":"number", "description":"Total expense costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace1":{ "type":"number", "description":"The total capital estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace2":{ "type":"number", "description":"The total capital estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace3":{ "type":"number", "description":"The total capital estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace1":{ "type":"number", "description":"The total expense estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace2":{ "type":"number", "description":"The total expense estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace3":{ "type":"number", "description":"The total expense estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetWorkspace1":{ "type":"number", "description":"The Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved.
                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetWorkspace2":{ "type":"number", "description":"The Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved.
                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetWorkspace3":{ "type":"number", "description":"The Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved.
                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostWorkspace1":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostWorkspace2":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostWorkspace3":{ "type":"number", "description":"The Proposed capital Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostWorkspace1":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostWorkspace2":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostWorkspace3":{ "type":"number", "description":"The Proposed expense Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributed":{ "type":"number", "description":"The amount of planned budget allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedWorkspace1":{ "type":"number", "description":"The amount of planned budget allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedWorkspace2":{ "type":"number", "description":"The amount of planned budget allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedWorkspace3":{ "type":"number", "description":"The amount of planned budget allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributed":{ "type":"number", "description":"The amount of planned budget unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedWorkspace1":{ "type":"number", "description":"The amount of planned budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedWorkspace2":{ "type":"number", "description":"The amount of planned budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedWorkspace3":{ "type":"number", "description":"The amount of planned budget unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValue":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedWorkspace1":{ "type":"number", "description":"The amount of forecast cost currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedWorkspace2":{ "type":"number", "description":"The amount of forecast cost currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedWorkspace3":{ "type":"number", "description":"The amount of forecast cost currently allocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributed":{ "type":"number", "description":"The amount of forecast cost unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedWorkspace1":{ "type":"number", "description":"The amount of forecast cost unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedWorkspace2":{ "type":"number", "description":"The amount of forecast cost unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedWorkspace3":{ "type":"number", "description":"The amount of forecast cost unallocated across the project timescale. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValue":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostWorkspace1":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                                      The cost value used for the Earned Value Management of a project.
                                                                                      Earned Value Management allows project managers to quantify project progress and objectively measure a project's success.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostWorkspace2":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                                      The cost value used for the Earned Value Management of a project.
                                                                                      Earned Value Management allows project managers to quantify project progress and objectively measure a project's success.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostWorkspace3":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                                      The cost value used for the Earned Value Management of a project.
                                                                                      Earned Value Management allows project managers to quantify project progress and objectively measure a project's success.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostWorkspace1":{ "type":"number", "description":"The expected total cost of the project when the defined scope of work will be completed.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostWorkspace2":{ "type":"number", "description":"The expected total cost of the project when the defined scope of work will be completed.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostWorkspace3":{ "type":"number", "description":"The expected total cost of the project when the defined scope of work will be completed.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostWorkspace1":{ "type":"number", "description":"The estimated cost needed to complete the project.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostWorkspace2":{ "type":"number", "description":"The estimated cost needed to complete the project.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostWorkspace3":{ "type":"number", "description":"The estimated cost needed to complete the project.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostWorkspace1":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a project.
                                                                                      Planned Value Cost is often used for Earned Value Management.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostWorkspace2":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a project.
                                                                                      Planned Value Cost is often used for Earned Value Management.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostWorkspace3":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a project.
                                                                                      Planned Value Cost is often used for Earned Value Management.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceWorkspace1":{ "type":"number", "description":"The measure of schedule performance on a project.
                                                                                      A negative value indicates that less work was actually performed than was scheduled.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceWorkspace2":{ "type":"number", "description":"The measure of schedule performance on a project.
                                                                                      A negative value indicates that less work was actually performed than was scheduled.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceWorkspace3":{ "type":"number", "description":"The measure of schedule performance on a project.
                                                                                      A negative value indicates that less work was actually performed than was scheduled.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "netPresentValueWorkspace1":{ "type":"number", "description":"The difference between the present value (PV) of the future cash flows from current investments and project costs.
                                                                                      The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                      Positive Net Present Value (NPV) is an indicator of projects that should be pursued.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "netPresentValueWorkspace2":{ "type":"number", "description":"The difference between the present value (PV) of the future cash flows from current investments and project costs.
                                                                                      The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                      Positive Net Present Value (NPV) is an indicator of projects that should be pursued.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "netPresentValueWorkspace3":{ "type":"number", "description":"The difference between the present value (PV) of the future cash flows from current investments and project costs.
                                                                                      The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                      Positive Net Present Value (NPV) is an indicator of projects that should be pursued.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedWorkspace1":{ "type":"number", "description":"The amount of benefits currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedWorkspace2":{ "type":"number", "description":"The amount of benefits currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedWorkspace3":{ "type":"number", "description":"The amount of benefits currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedWorkspace1":{ "type":"number", "description":"The amount of benefits that have not been allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedWorkspace2":{ "type":"number", "description":"The amount of benefits that have not been allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedWorkspace3":{ "type":"number", "description":"The amount of benefits that have not been allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project benefits. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project benefits. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project benefits. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValue":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValue":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributed":{ "type":"number", "description":"The capital amount of forecast cost currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValue":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributed":{ "type":"number", "description":"The expense amount of forecast cost currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValue":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValue":{ "type":"number", "description":"The capital present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValue":{ "type":"number", "description":"The expense present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributed":{ "type":"number", "description":"The capital amount of planned budget allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributed":{ "type":"number", "description":"The expense amount of planned budget allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace1":{ "type":"number", "description":"The At Completion Total Cost from a cost-loaded P6 EPPM schedule.
                                                                                      At Completion data is only available when the application is connected to P6 EPPM and is not editable.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace2":{ "type":"number", "description":"The At Completion Total Cost from a cost-loaded P6 EPPM schedule.
                                                                                      At Completion data is only available when the application is connected to P6 EPPM and is not editable.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace3":{ "type":"number", "description":"The At Completion Total Cost from a cost-loaded P6 EPPM schedule.
                                                                                      At Completion data is only available when the application is connected to P6 EPPM and is not editable.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostDistributedProject":{ "type":"number", "description":"The amount of project actuals currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCostUnDistributedProject":{ "type":"number", "description":"The amount of project actuals unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueProject":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueProject":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project forecast. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedProject":{ "type":"number", "description":"The capital amount of forecast cost currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUnDistributed":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUnDistributedProject":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedProject":{ "type":"number", "description":"The expense amount of forecast cost currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUnDistributed":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUnDistributedProject":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueProject":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueProject":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall project planned budget. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedProject":{ "type":"number", "description":"The capital amount of planned budget allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUnDistributed":{ "type":"number", "description":"The capital amount of planned budget unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedProject":{ "type":"number", "description":"The expense amount of planned budget allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUnDistributed":{ "type":"number", "description":"The expense amount of planned budget unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueProject":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueProject":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedProject":{ "type":"number", "description":"The capital amount of project actuals currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUnDistributed":{ "type":"number", "description":"The capital amount of project actuals unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUnDistributedProject":{ "type":"number", "description":"The capital amount of project actuals unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedProject":{ "type":"number", "description":"The expense amount of project actuals currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUnDistributed":{ "type":"number", "description":"The expense amount of project actuals unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUnDistributedProject":{ "type":"number", "description":"The expense amount of project actuals unallocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostPresentValue":{ "type":"number", "description":"The capital present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostPresentValue":{ "type":"number", "description":"The expense present value, also known as discounted value, of the portfolio proposed budget. Future cash flows are discounted using the project's annual discount rate. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostDistributed":{ "type":"number", "description":"The capital amount of proposed budget currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetCapitalCostUnDistributed":{ "type":"number", "description":"The capital amount of proposed budget unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostDistributed":{ "type":"number", "description":"The expense amount of proposed budget currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetExpenseCostUnDistributed":{ "type":"number", "description":"The expense amount of proposed budget unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace1":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "constructionValueProject":{ "minimum":0, "type":"number", "description":"Construction Value is the total of all project-related costs incurred by the constructing company (usually a General Contractor) over the period of construction. This would generally include cost of materials, subcontract totals, overhead costs, general conditions and tax. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "constructionValueWorkspace1":{ "minimum":0, "type":"number", "description":"Construction Value is the total of all project-related costs incurred by the constructing company (usually a General Contractor) over the period of construction based on workspace currency 1. This would generally include cost of materials, subcontract totals, overhead costs, general conditions and tax.", "format":"double", "exampleSetFlag":false }, "constructionValueWorkspace2":{ "minimum":0, "type":"number", "description":"Construction Value is the total of all project-related costs incurred by the constructing company (usually a General Contractor) over the period of construction based on workspace currency 2. This would generally include cost of materials, subcontract totals, overhead costs, general conditions and tax.", "format":"double", "exampleSetFlag":false }, "constructionValueWorkspace3":{ "minimum":0, "type":"number", "description":"Construction Value is the total of all project-related costs incurred by the constructing company (usually a General Contractor) over the period of construction based on workspace currency 3. This would generally include cost of materials, subcontract totals, overhead costs, general conditions and tax.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedProject":{ "type":"number", "description":"The amount of benefits currently allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedProject":{ "type":"number", "description":"The amount of benefits that have not been allocated across the project timescale. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceProject":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVarProject":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVarProject":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Approved Budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVariance":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentApprovedSpendVarianceProject":{ "type":"number", "description":"The total and time phased variance between the project's Approved Budget and Actuals. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedForecastVariance":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedForecastVarianceProject":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Forecast. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueProject":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project benefits. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundForecastVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Forecast. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundForecastVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Forecast. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "allocatedFundForecastVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the project's Allocated Fund and Forecast. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsProject":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "constructionValue":{ "minimum":0, "type":"number", "description":"Construction Value is the total of all project-related costs incurred by the constructing company (usually a General Contractor) over the period of construction. This would generally include cost of materials, subcontract totals, overhead costs, general conditions and tax. This field is in base currency and is calculated from constructionValueProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendForecastVarProject":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVar":{ "type":"number", "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVar":{ "type":"number", "description":"The total and time phased variance between the project's Forecast and Approved Budget. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostProject":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCost":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule when the project is summarized.
                                                                                      The value for actual cost cannot be entered/edited manually through UI.", "format":"double", "exampleSetFlag":false }, "benefits":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendForecastVar":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Forecast. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendPlannedVariance":{ "type":"number", "description":"The total and time phased variance between the project's Actuals and Planned Budget. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "ytdSpendCost":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace1":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace2":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace3":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostProject":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                                      The cost value used for the Earned Value Management of a project.
                                                                                      Earned Value Management allows project managers to quantify project progress and objectively measure a project's success.
                                                                                      This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostProject":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a project.
                                                                                      Planned Value Cost is often used for Earned Value Management.
                                                                                      This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceProject":{ "type":"number", "description":"The measure of schedule performance on a project.
                                                                                      A negative value indicates that less work was actually performed than was scheduled.
                                                                                      This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "costVariance":{ "type":"number", "description":"The measure of cost performance on a project.
                                                                                      A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                      This value can be entered manually or can be imported. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCost":{ "type":"number", "description":"The total estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCostProject":{ "type":"number", "description":"The total estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudget":{ "type":"number", "description":"The planned total cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetProject":{ "type":"number", "description":"The planned total cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudget":{ "type":"number", "description":"The budget currently approved for the project.
                                                                                      Current Approved Budget values are derived from the Proposed Budget set by the budget planner.
                                                                                      A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudget":{ "type":"number", "description":"The Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedBudgetProject":{ "type":"number", "description":"The Proposed Budget for the project as allocated by the budget planner.
                                                                                      Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts.
                                                                                      If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews.
                                                                                      Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCost":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendCost":{ "type":"number", "description":"The total amount incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendCostProject":{ "type":"number", "description":"The total amount incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCost":{ "type":"number", "description":"The total capital estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCost":{ "type":"number", "description":"The total expense estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCost":{ "type":"number", "description":"Total capital costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCost":{ "type":"number", "description":"Total expense costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapital":{ "type":"number", "description":"The planned total capital cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpense":{ "type":"number", "description":"The planned total expense cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace1":{ "type":"number", "description":"The planned total cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace2":{ "type":"number", "description":"The planned total cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace3":{ "type":"number", "description":"The planned total cost of a project as defined by the project manager.
                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostWorkspace1":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostWorkspace2":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostWorkspace3":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                                      The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                      Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace1":{ "type":"number", "description":"The total estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace2":{ "type":"number", "description":"The total estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace3":{ "type":"number", "description":"The total estimation of a project's remaining costs.
                                                                                      Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCost":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a project.
                                                                                      Planned Value Cost is often used for Earned Value Management.
                                                                                      This value can be entered manually or can be imported. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedValueCost":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                                      The cost value used for the Earned Value Management of a project.
                                                                                      Earned Value Management allows project managers to quantify project progress and objectively measure a project's success.
                                                                                      This value can be entered manually or can be imported. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"The At Completion Total Cost from a cost-loaded P6 EPPM schedule.
                                                                                      At Completion data is only available when the application is connected to P6 EPPM and is not editable.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCostDistributed":{ "type":"number", "description":"The amount of project actuals currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributed":{ "type":"number", "description":"The amount of forecast cost currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValue":{ "type":"number", "description":"The present value, also known as discounted value, of the overall project actuals. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "costVarianceWorkspace1":{ "type":"number", "description":"The measure of cost performance on a project.
                                                                                      A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "costVarianceWorkspace2":{ "type":"number", "description":"The measure of cost performance on a project.
                                                                                      A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "costVarianceWorkspace3":{ "type":"number", "description":"The measure of cost performance on a project.
                                                                                      A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                      This value can be entered manually or can be imported. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCost":{ "type":"number", "description":"The expected total cost of the project when the defined scope of work will be completed.
                                                                                      This value can be entered manually or can be imported. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "estToCompleteCost":{ "type":"number", "description":"The estimated cost needed to complete the project.
                                                                                      This value can be entered manually or can be imported. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "scheduleVariance":{ "type":"number", "description":"The measure of schedule performance on a project.
                                                                                      A negative value indicates that less work was actually performed than was scheduled.
                                                                                      This value can be entered manually or can be imported. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "netPresentValue":{ "type":"number", "description":"The difference between the present value (PV) of the future cash flows from current investments and project costs.
                                                                                      The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                      Positive Net Present Value (NPV) is an indicator of projects that should be pursued.
                                                                                      This value can be entered manually or can be imported. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "benefitsDistributed":{ "type":"number", "description":"The amount of benefits currently allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributed":{ "type":"number", "description":"The amount of benefits that have not been allocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValue":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall project benefits. Future cash flows are discounted using the project's annual discount rate. Portfolio managers can use the present value of a project's expected cash flow as a metric during project prioritization and selection. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "costPerfIndex":{ "type":"number", "description":"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.
                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "schedPerfIndex":{ "type":"number", "description":"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.
                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "paybackPeriod":{ "type":"number", "description":"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.


                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "profitabilityIndex":{ "type":"number", "description":"The index based on the value of a project's present values divided by initial project investments.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "annualDiscountRate":{ "maximum":1, "minimum":0, "type":"number", "description":"The interest rate associated with the cost of an investment from your commercial bank or another funding source.
                                                                                      For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value.
                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace1":{ "type":"number", "description":"The total amount incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace2":{ "type":"number", "description":"The total amount incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace3":{ "type":"number", "description":"The total amount incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                      Actuals cannot be edited if a project has a status of Proposal. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace1":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace2":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace3":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostUnDistributed":{ "type":"number", "description":"The amount of project actuals unallocated across the project timescale. This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "budgetOriginalCost":{ "type":"number", "description":"The total original cost of the project budget, before transfers and changes. This field is in base currency and is calculated from budgetOriginalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "netPresentValueProject":{ "type":"number", "description":"The difference between the present value (PV) of the future cash flows from current investments and project costs.
                                                                                      The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                      Positive Net Present Value (NPV) is an indicator of projects that should be pursued.
                                                                                      This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "returnInvestment":{ "type":"number", "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a project or portfolio.
                                                                                      For example, a project is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%.
                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "costVarianceProject":{ "type":"number", "description":"The measure of cost performance on a project.
                                                                                      A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                      This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "intRateReturn":{ "type":"number", "description":"The quantitative measurement used to compare the profitability of project investments.
                                                                                      The rate at which investors will receive returns on their investments in a project.
                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostProject":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.
                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "budgetCurrentCost":{ "type":"number", "description":"The total cost of the project budget, including all transfers and changes. This field is in base currency and is calculated from budgetCurrentCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The remaining total cost for the project, including labor resources, nonlabor resources, and project expenses when the project is summarized.
                                                                                      This value can be imported and integrated.
                                                                                      The value for remaining Cost cannot be entered/edited manually through UI.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The At Completion Total Cost from a cost-loaded P6 EPPM schedule.
                                                                                      The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule when the project is summarized.
                                                                                      The value for At Completion Cost cannot be entered/edited manually through UI.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier for a project set by the user who created the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "project":{ "description":"Project object of project financial.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProject" } ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectImage":{ "title":"ApiEntityProjectImage", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectImageId":{ "type":"integer", "description":"The system-generated identifier of a project image. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "imageType":{ "type":"string", "description":"The mime type of an image associated with a project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PNG", "JPEG", "GIF" ] }, "project":{ "type":"integer", "description":"The system-generated identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "image":{ "type":"string", "description":"The image file uploaded to the project.
                                                                                      Displayed throughout the application in areas like news feeds.", "format":"byte", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectIntegrationSource":{ "title":"ApiEntityProjectIntegrationSource", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectIntegrationSourceId":{ "type":"integer", "description":"The system-generated identifier of the project integration source. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceProjectName":{ "maxLength":255, "type":"string", "description":"The Project name of Integration source.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceProjectId":{ "maxLength":255, "type":"string", "description":"The Project identifier of Integration source.", "exampleSetFlag":false, "types":[ "string" ] }, "integrationSource":{ "type":"string", "description":"The source of Integration.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "P6", "UNIFIER" ] }, "lastIntegratedDate":{ "type":"string", "description":"The date of the last successful Integration.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier of the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectSetting":{ "title":"ApiEntityProjectSetting", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "settingName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a project button.", "exampleSetFlag":false, "types":[ "string" ] }, "settingValue":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Value of a project setting.", "exampleSetFlag":false, "types":[ "string" ] }, "projectSettingId":{ "type":"integer", "description":"The unique identifier of a project setting. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRemovePortfolioUserPermissionsResponse":{ "title":"ApiEntityRemovePortfolioUserPermissionsResponse", "type":"object", "properties":{ "message":{ "type":"string", "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRemovePortfolioUserPermissions":{ "title":"ApiEntityRemovePortfolioUserPermissions", "type":"object", "properties":{ "userNames":{ "type":"array", "description":"List of user names for removing users.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCapitalPortfolioMember":{ "title":"ApiEntityCapitalPortfolioMember", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "memberPortfolioWorkspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "memberPortfolioWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "capitalPortfolioMemberId":{ "type":"integer", "description":"The unique identifier of a portfolio member.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The unique identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "memberPortfolioId":{ "type":"integer", "description":"The unique identifier of a portfolio associated to a portfolio member.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "memberPortfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a portfolio associated to a portfolio member.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the workspace associated to a portfolio member.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCapitalPortfolioMemberInput":{ "title":"ApiEntityCapitalPortfolioMemberInput", "required":[ "capitalPortfolioId", "memberPortfolioId" ], "type":"object", "properties":{ "memberPortfolioWorkspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "memberPortfolioWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "capitalPortfolioMemberId":{ "type":"integer", "description":"The unique identifier of a portfolio member.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The unique identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "memberPortfolioId":{ "type":"integer", "description":"The unique identifier of a portfolio associated to a portfolio member.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "memberPortfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a portfolio associated to a portfolio member.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the workspace associated to a portfolio member.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a CapitalPortfolioMember object, a unique CapitalPortfolioMember object can be identified by the following combinations of the fields.
                                                                                      • portfolioId
                                                                                      • name,workspaceId
                                                                                      • name,workspaceCode
                                                                                        • ", "exampleSetFlag":false }, "ApiEntityChangeRequest":{ "title":"ApiEntityChangeRequest", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"The type of change.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CHANGE", "NEW", "TRANSFER" ] }, "withdrawnApprovalByUserId":{ "type":"integer", "description":"The user who withdrew approval of the change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceObjectType":{ "type":"string", "description":"Type of object on which a change request is operating. Changes can run against scope items or work packages.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SCOPE_ITEM", "WORK_PACKAGE" ] }, "maxSuffix":{ "type":"integer", "description":"The maximum value allowed for a code suffix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approvalDate":{ "type":"string", "description":"The date the change request was approved.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "withdrawnApprovalDate":{ "type":"string", "description":"The date the approved change request was withdrawn.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "changeRequestId":{ "type":"integer", "description":"The unique identifier of the change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectedByUserId":{ "type":"integer", "description":"The user who rejected the change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reopenedByUserId":{ "type":"integer", "description":"The user who reopened the rejected change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectedDate":{ "type":"string", "description":"The date the change request was rejected.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "reopenedDate":{ "type":"string", "description":"The date the rejected change request was reopened.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finalizedById":{ "type":"integer", "description":"The user who accepted the change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "changeRequestCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of the change request.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A summary of the purpose for the change.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBaselineId":{ "type":"integer", "description":"The unique identifier of the project baseline associated with the change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the change request.
                                                                                        Pending: The change request is submitted and awaiting a decision.
                                                                                        Approved: The change request was approved.
                                                                                        Rejected: The change request was not approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityChangeRequestInput":{ "title":"ApiEntityChangeRequestInput", "required":[ "projectId", "sourceObjectType" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"The type of change.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CHANGE", "NEW", "TRANSFER" ] }, "sourceObjectType":{ "type":"string", "description":"Type of object on which a change request is operating. Changes can run against scope items or work packages.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SCOPE_ITEM", "WORK_PACKAGE" ] }, "maxSuffix":{ "type":"integer", "description":"The maximum value allowed for a code suffix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "changeRequestId":{ "type":"integer", "description":"The unique identifier of the change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "finalizedById":{ "type":"integer", "description":"The user who accepted the change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "changeRequestCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of the change request.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A summary of the purpose for the change.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBaselineId":{ "type":"integer", "description":"The unique identifier of the project baseline associated with the change request.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the change request.
                                                                                        Pending: The change request is submitted and awaiting a decision.
                                                                                        Approved: The change request was approved.
                                                                                        Rejected: The change request was not approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ] } }, "description":"This entity represents a ChangeRequest object, a unique ChangeRequest object can be identified by the following combinations of the fields.
                                                                                        • changeRequestId
                                                                                        • changeRequestCode,projectId
                                                                                        • changeRequestCode,projectCode,workspaceCode
                                                                                          • ", "exampleSetFlag":false }, "ApiEntityCodeEntityType":{ "title":"ApiEntityCodeEntityType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeType":{ "description":"The unique identifier of a code type.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCodeType" } ] }, "entityType":{ "maxLength":60, "type":"string", "description":"Indicates the type of object the code is associated to.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "CONSTRAINT", "CUSTOM_LOG_ITEM", "DOCUMENT", "FUND", "IDEA", "PBS", "PORTFOLIO", "PROGRAM", "PROJECT", "REPORT", "RESOURCE", "RISK", "SCOPE_ASSIGNMENT", "SCOPE_ITEM", "STRATEGY", "TASKS", "WBS", "WORK_PACKAGE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeType":{ "title":"ApiEntityCodeType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the workspace code.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the code type and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "assignments":{ "type":"array", "description":"The list of code type assignments.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeEntityType", "exampleSetFlag":false }, "types":[ "array" ] }, "codeTypeId":{ "type":"integer", "description":"The system-generated identifier of a code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"Displays the code or ID of the Code Type.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeEntityTypeInput":{ "title":"ApiEntityCodeEntityTypeInput", "required":[ "codeType", "entityType" ], "type":"object", "properties":{ "codeType":{ "description":"The unique identifier of a code type.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCodeTypeInput" } ] }, "entityType":{ "maxLength":60, "type":"string", "description":"Indicates the type of object the code is associated to.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "CONSTRAINT", "CUSTOM_LOG_ITEM", "DOCUMENT", "FUND", "IDEA", "PBS", "PORTFOLIO", "PROGRAM", "PROJECT", "REPORT", "RESOURCE", "RISK", "SCOPE_ASSIGNMENT", "SCOPE_ITEM", "STRATEGY", "TASKS", "WBS", "WORK_PACKAGE" ] } }, "exampleSetFlag":false }, "ApiEntityCodeTypeInput":{ "title":"ApiEntityCodeTypeInput", "required":[ "codeTypeCode", "codeTypeName", "projectId", "workspaceId" ], "type":"object", "properties":{ "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the workspace code.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "assignments":{ "type":"array", "description":"The list of code type assignments.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeEntityTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "codeTypeId":{ "type":"integer", "description":"The system-generated identifier of a code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"Displays the code or ID of the Code Type.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a CodeType object, a unique CodeType object can be identified by the following combinations of the fields.
                                                                                          • codeTypeId
                                                                                          • codeTypeCode,projectId
                                                                                          • codeTypeCode,projectCode,workspaceCode
                                                                                          • codeTypeCode,workspaceId
                                                                                          • codeTypeCode,workspaceCode
                                                                                            • ", "exampleSetFlag":false }, "ApiEntityPromoteProjectCodeType":{ "title":"ApiEntityPromoteProjectCodeType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The ID of the owning workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeId":{ "type":"integer", "description":"The system-generated identifier of a code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"Displays the code or ID of the Code Type.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The system generated identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValue":{ "title":"ApiEntityCodeValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "color":{ "maxLength":255, "type":"string", "description":"A color for the code value.
                                                                                            The hexadecimal color code (in lower case) are the allowed values for this field.
                                                                                            Example: #00008B", "exampleSetFlag":false, "types":[ "string" ] }, "parentCVCodes":{ "type":"array", "description":"List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of the project of a project code type associated with the code value. ", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "parentCodeValueCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The parent code value code of a code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueInput":{ "title":"ApiEntityCodeValueInput", "required":[ "codeTypeId", "codeValueCode", "codeValueName" ], "type":"object", "properties":{ "color":{ "maxLength":255, "type":"string", "description":"A color for the code value.
                                                                                            The hexadecimal color code (in lower case) are the allowed values for this field.
                                                                                            Example: #00008B", "exampleSetFlag":false, "types":[ "string" ] }, "parentCVCodes":{ "type":"array", "description":"List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of the project of a project code type associated with the code value. ", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a CodeValue object, a unique CodeValue object can be identified by the following combinations of the fields.
                                                                                            • codeValueId
                                                                                            • codeValueCode,codeTypeId
                                                                                            • codeValueCode,codeTypeCode,projectCode,workspaceCode
                                                                                            • codeValueCode,codeTypeCode,workspaceCode
                                                                                              • ", "exampleSetFlag":false }, "ApiEntityCompany":{ "title":"ApiEntityCompany", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "companyEnterpriseCertifications":{ "type":"array", "description":"List of enterprise certifications held by the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyEnterpriseCertification", "exampleSetFlag":false }, "types":[ "array" ] }, "companyWorkTypes":{ "type":"array", "description":"List of types of work or specialties of the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyWorkType", "exampleSetFlag":false }, "types":[ "array" ] }, "companyLaborTypes":{ "type":"array", "description":"List of labor union types applicable for the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyLaborType", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information about the company.", "exampleSetFlag":false, "types":[ "string" ] }, "businessRoleTypes":{ "type":"array", "description":"The business types for a company.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ARCHITECT", "ARCHITECT_ENGINEER", "CONSTRUCTION_MANAGER", "CONSULTANT", "CONTRACTOR", "CUSTOMER", "DESIGN_CONSULTANT", "DEVELOPER", "ENGINEER", "HEAD_CONTRACTOR", "OTHER", "OWNER", "OWNER_REP", "PROJECT_MANAGER", "QUANTITY_SURVEYOR", "RESELLER", "SUB_CONTRACTOR", "SUPPLIER", "VENDOR" ] }, "types":[ "array" ] }, "isTenantOwned":{ "type":"boolean", "description":"Indicates whether or not the company is an application tenant.", "exampleSetFlag":false, "types":[ "boolean" ] }, "sourceSiteId":{ "maxLength":255, "type":"string", "description":"The unique identifier of a company site in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "organizationId":{ "type":"integer", "description":"The unique identifier for the organization.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "qualificationStatus":{ "type":"string", "description":"Qualification status of a Company according to the tenant", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CONDITIONALLY_QUALIFIED", "NOT_QUALIFIED", "NO_STATUS", "QUALIFIED" ] }, "performanceRating":{ "type":"string", "description":"Performance Rating of a Company determined by the tenant.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NO_PERFORMANCE_RATING", "PERFORMANCE_LEVEL_FIVE", "PERFORMANCE_LEVEL_FOUR", "PERFORMANCE_LEVEL_THREE", "PERFORMANCE_LEVEL_TWO", "PERFORMANCE_LEVEL_ONE" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "distance":{ "type":"number", "description":"The distance the company is willing to travel for the project from the corporate office.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "distanceMetric":{ "type":"string", "description":"The distance measure to be used for corporate office distance. Valid options include kilometer and mile.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "KILOMETERS", "MILES" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of company data in an external source.", "example":"coarse", "exampleSetFlag":true, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the company's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The workspace that the company was created in. All changes to the company must be made in the owning workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"The latitude of a company.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                              This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                              This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the company. Valid values are Active and Inactive.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "url":{ "maxLength":255, "minLength":0, "type":"string", "description":"The website of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "offices":{ "type":"array", "description":"Offices associated with the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityOffice", "exampleSetFlag":false }, "types":[ "array" ] }, "fax":{ "maxLength":32, "minLength":0, "type":"string", "description":"The fax number for the company.", "exampleSetFlag":false, "types":[ "string" ] }, "phone":{ "maxLength":32, "minLength":0, "type":"string", "description":"The phone number for the company.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCompanyConfiguredFieldValue":{ "title":"ApiEntityCompanyConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "companyConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the company configured field. This value should not be provided in create operation request data; however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":1000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "exceptionMessage":{ "maxLength":1000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCompanyEnterpriseCertification":{ "title":"ApiEntityCompanyEnterpriseCertification", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "companyEnterpriseCertificationTypeName":{ "type":"string", "description":"Enterprise Certifications held by the Company", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DISABLED_VETERAN_BUSINESS_ENTERPRISE_DVBE", "DISADVANTAGED_BUSINESS_ENTERPRISE_DBE", "EIGHT_A_BUSINESS", "SMALL_BUSINESS_ENTERPRISE_SBE", "UNDERUTILIZED_BUSINESS_HUB", "WOMEN_BUSINESS_ENTERPRISE_WBE", "MINORITY_BUSINESS_ENTERPRISE_MBE" ] }, "certificationId":{ "type":"integer", "description":"A unique identifier for the enterprise certification held by the company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCompanyLaborType":{ "title":"ApiEntityCompanyLaborType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "laborTypeAssociationId":{ "type":"integer", "description":"A unique identifier for labor type applicable for the company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyLaborTypeName":{ "type":"string", "description":"Labor union types applicable for the Company", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NON_UNION", "PREVAILING_WAGE", "UNION" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCompanyWorkType":{ "title":"ApiEntityCompanyWorkType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workTypeId":{ "type":"integer", "description":"A unique identifier for type of work of the company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workTypeName":{ "type":"string", "description":"Types of Work or Specialties of the Company", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROCUREMENT_AND_CONTRACTING_REQUIREMENTS", "SOLICITATION", "INSTRUCTIONS_FOR_PROCUREMENT", "AVAILABLE_INFORMATION", "PROCUREMENT_FORMS_AND_SUPPLEMENTS", "CONTRACTING_FORMS_AND_SUPPLEMENTS", "PROJECT_FORMS", "CONDITIONS_OF_THE_CONTRACT", "REVISIONS_CLARIFICATIONS_AND_MODIFICATIONS", "SUMMARY", "ADMINISTRATIVE_REQUIREMENTS", "QUALITY_REQUIREMENTS", "TEMPORARY_FACILITIES_AND_CONTROLS", "PRODUCT_REQUIREMENTS", "EXECUTION_AND_CLOSEOUT_REQUIREMENTS", "PERFORMANCE_REQUIREMENTS", "LIFE_CYCLE_ACTIVITIES", "EXISTING_CONDITIONS", "ASSESSMENT", "SUBSURFACE_INVESTIGATION", "DEMOLITION_AND_STRUCTURE_MOVING", "SITE_REMEDIATION", "CONTAMINATED_SITE_MATERIAL_REMOVAL", "FACILITY_REMEDIATION", "CONCRETE", "CONCRETE_FORMING_AND_ACCESSORIES", "CONCRETE_REINFORCING", "CAST_IN_PLACE_CONCRETE", "CAST_DECKS_AND_UNDERLAYMENT", "GROUTING", "MASS_CONCRETE", "CONCRETE_CUTTING_AND_BORING", "MASONRY", "UNIT_MASONRY", "STONE_ASSEMBLIES", "REFRACTORY_MASONRY", "CORROSION_RESISTANT_MASONRY", "MANUFACTURED_MASONRY", "METALS", "METAL_DECKING", "COLD_FORMED_METAL_FRAMING", "METAL_FABRICATIONS", "DECORATIVE_METAL", "WOOD_PLASTICS_AND_COMPOSITES", "ROUGH_CARPENTRY", "ARCHITECTURAL_WOODWORK", "PLASTIC_FABRICATIONS", "STRUCTURAL_COMPOSITES", "COMPOSITE_FABRICATIONS", "THERMAL_AND_MOISTURE_PROTECTION", "DAMPPROOFING_AND_WATERPROOFING", "THERMAL_PROTECTION", "ROOFING_AND_SIDING_PANELS", "MEMBRANE_ROOFING", "FLASHING_AND_SHEET_METAL", "ROOF_AND_WALL_SPECIALTIES_AND_ACCESSORIES", "FIRE_AND_SMOKE_PROTECTION", "JOINT_PROTECTION", "OPENINGS", "DOORS_AND_FRAMES", "SPECIALTY_DOORS_AND_FRAMES", "ENTRANCES_STOREFRONTS_AND_CURTAIN_WALLS", "WINDOWS", "ROOF_WINDOWS_AND_SKYLIGHTS", "HARDWARE", "GLAZING", "LOUVERS_AND_VENTS", "FINISHES", "PLASTER_AND_GYPSUM_BOARD", "SPECIALIZED_SYSTEMS", "CEILINGS", "FLOORING", "ACOUSTIC_TREATMENT", "PAINTING_AND_COATING", "SPECIALTIES", "INFORMATION_SPECIALTIES", "FIREPLACES_AND_STOVES", "SAFETY_SPECIALTIES", "STORAGE_SPECIALTIES", "OTHER_SPECIALTIES", "EQUIPMENT", "VEHICLE_AND_PEDESTRIAN_EQUIPMENT", "COMMERCIAL_EQUIPMENT", "RESIDENTIAL_EQUIPMENT", "FOODSERVICE_EQUIPMENT", "EDUCATIONAL_AND_SCIENTIFIC_EQUIPMENT", "HEALTHCARE_EQUIPMENT", "FACILITY_MAINTENANCE_AND_OPERATION_EQUIPMENT", "OTHER_EQUIPMENT", "FURNISHINGS", "ART", "WINDOW_TREATMENTS", "CASEWORK", "FURNISHINGS_AND_ACCESSORIES", "FURNITURE", "OTHER_FURNISHINGS", "SPECIAL_CONSTRUCTION", "SPECIAL_FACILITY_COMPONENTS", "SPECIAL_PURPOSE_ROOMS", "SPECIAL_STRUCTURES", "INTEGRATED_CONSTRUCTION", "LIFTS", "DUMBWAITERS", "ELEVATORS", "ESCALATORS_AND_MOVING_WALKS", "TURNTABLES", "SCAFFOLDING", "FIRE_SUPPRESSION", "WATER_BASED_FIRE_SUPPRESSION_SYSTEMS", "FIRE_EXTINGUISHING_SYSTEMS", "FIRE_PUMPS", "FIRE_SUPPRESSION_WATER_STORAGE", "PLUMBING", "PLUMBING_PIPING", "PLUMBING_EQUIPMENT", "PLUMBING_FIXTURES", "POOL_AND_FOUNTAIN_PLUMBING_SYSTEMS", "GAS_AND_VACUUM_SYSTEMS_FOR_LABORATORY_AND_HEALTHCARE", "HEATING_VENTILATING_AND_AIR_CONDITIONING_HVAC", "FACILITY_FUEL_SYSTEMS", "HVAC_PIPING_AND_PUMPS", "HVAC_AIR_DISTRIBUTION", "HVAC_AIR_CLEANING_DEVICES", "CENTRAL_HEATING_EQUIPMENT", "CENTRAL_COOLING_EQUIPMENT", "CENTRAL_HVAC_EQUIPMENT", "DECENTRALIZED_HVAC_EQUIPMENT", "INTEGRATED_AUTOMATION", "INTEGRATED_AUTOMATION_NETWORK_EQUIPMENT", "INTEGRATED_AUTOMATION_INSTRUMENTATION_AND_TERMINAL_DEVICES", "PROCESS_CONTROL_AND_ENTERPRISE_MANAGEMENT_SYSTEMS", "INTEGRATED_AUTOMATION_FACILITY_CONTROLS", "INTEGRATED_AUTOMATION_CONTROL_SEQUENCES", "ELECTRICAL", "MEDIUM_VOLTAGE_ELECTRICAL_DISTRIBUTION", "LOW_VOLTAGE_ELECTRICAL_DISTRIBUTION", "WELLS", "LIGHTING", "COMMUNICATIONS", "STRUCTURED_CABLING", "DATA_COMMUNICATIONS", "VOICE_COMMUNICATIONS", "AUDIO_VIDEO_COMMUNICATIONS", "DISTRIBUTED_COMMUNICATIONS_AND_MONITORING_SYSTEMS", "ACCESS_CONTROL", "VIDEO_SURVEILLANCE", "SECURITY_DETECTION_ALARM_AND_MONITORING", "INSTRUMENTATION_FOR_PROCESS_SYSTEMS", "EARTHWORK", "SITE_CLEARING", "EARTH_MOVING", "EARTHWORK_METHODS", "SHORING_AND_UNDERPINNING", "BASES_BALLASTS_AND_PAVING", "SITE_IMPROVEMENTS", "WETLANDS", "IRRIGATION", "PLANTING", "UTILITIES", "WATER_UTILITIES", "SANITARY_SEWERAGE", "COMMUNICATIONS_UTILITIES", "TRANSPORTATION", "GUIDEWAYS_RAILWAYS", "TRACTION_POWER", "TRANSPORTATION_FARE_COLLECTION_EQUIPMENT", "BRIDGES", "WATERWAY_AND_MARINE_CONSTRUCTION", "WATERWAY_AND_MARINE_CONSTRUCTION_AND_EQUIPMENT", "COASTAL_CONSTRUCTION", "MARINE_CONSTRUCTION_AND_EQUIPMENT", "DAM_CONSTRUCTION_AND_EQUIPMENT", "PROCESS_INTERCONNECTIONS", "LIQUIDS_PROCESS_PIPING", "SOLID_AND_MIXED_MATERIALS_PIPING_AND_CHUTES", "COMMISSIONING_OF_PROCESS_SYSTEMS", "PRIMARY_CONTROL_DEVICES", "MATERIAL_PROCESSING_AND_HANDLING_EQUIPMENT", "PIECE_MATERIAL_HANDLING_EQUIPMENT", "MANUFACTURING_EQUIPMENT", "CONTAINER_PROCESSING_AND_PACKAGING", "MATERIAL_STORAGE", "MOBILE_PLANT_EQUIPMENT", "PROCESS_HEATING_COOLING_AND_DRYING_EQUIPMENT", "PROCESS_HEATING_EQUIPMENT", "PROCESS_COOLING_EQUIPMENT", "PROCESS_DRYING_EQUIPMENT", "GAS_HANDLING_EQUIPMENT", "LIQUID_HANDLING_EQUIPMENT", "GAS_AND_LIQUID_PURIFICATION_EQUIPMENT", "GAS_AND_LIQUID_STORAGE", "POLLUTION_AND_WASTE_CONTROL_EQUIPMENT", "NOISE_POLLUTION_CONTROL", "ODOR_CONTROL", "SOLID_WASTE_CONTROL_AND_REUSE", "WASTE_THERMAL_PROCESSING_EQUIPMENT", "INDUSTRY_SPECIFIC_MANUFACTURING_EQUIPMENT", "USER_DEFINED_TEXTILES_AND_APPAREL_MANUFACTURING_EQUIPMENT", "WATER_AND_WASTEWATER_EQUIPMENT", "WATER_AND_WASTEWATER_PRELIMINARY_TREATMENT_EQUIPMENT", "WATER_AND_WASTEWATER_CHEMICAL_FEED_EQUIPMENT", "WATER_AND_WASTEWATER_SECONDARY_TREATMENT_EQUIPMENT", "WATER_AND_WASTEWATER_RESIDUALS_HANDLING_AND_TREATMENT", "ELECTRICAL_POWER_GENERATION_TESTING", "USER_DEFINED_PETROLEUM_AND_COAL_PRODUCTS_MANUFACTURING", "USER_DEFINED_FABRICATED_METAL_PRODUCT_MANUFACTURING", "USER_DEFINED_FURNITURE_AND_RELATED_PRODUCT_MANUFACTURING", "COMBINED_HEAT_AND_POWER_GENERATION", "GENERAL_REQUIREMENTS", "PRICE_AND_PAYMENT_PROCEDURES", "WATER_REMEDIATION", "PRECAST_CONCRETE", "METAL_JOISTS", "FINISH_CARPENTRY", "STEEP_SLOPE_ROOFING", "WALL_FINISHES", "INTERIOR_SPECIALTIES", "EXTERIOR_SPECIALTIES", "ENTERTAINMENT_AND_RECREATION_EQUIPMENT", "MULTIPLE_SEATING", "SPECIAL_INSTRUMENTATION", "CONVEYING_EQUIPMENT", "OTHER_CONVEYING_EQUIPMENT", "ELECTRICAL_PROTECTION", "ELECTRONIC_SAFETY_AND_SECURITY", "LIFE_SAFETY", "EXCAVATION_SUPPORT_AND_PROTECTION", "SPECIAL_FOUNDATIONS_AND_LOAD_BEARING_ELEMENTS", "TUNNELING_AND_MINING", "EXTERIOR_IMPROVEMENTS", "STORMWATER_UTILITIES", "HYDROCARBON_UTILITIES", "HYDRONIC_AND_STEAM_ENERGY_UTILITIES", "TRANSPORTATION_SIGNALING_AND_CONTROL_EQUIPMENT", "TRANSPORTATION_CONSTRUCTION_AND_EQUIPMENT", "WATERWAY_AND_MARINE_SIGNALING_AND_CONTROL_EQUIPMENT", "WATERWAY_CONSTRUCTION_AND_EQUIPMENT", "GAS_AND_VAPOR_PROCESS_PIPING_AND_DUCTWORK", "PROCESS_PIPING_AND_EQUIPMENT_PROTECTION", "BULK_MATERIAL_PROCESSING_EQUIPMENT", "PROCESS_GAS_AND_LIQUID_HANDLING_PURIFICATION_AND_STORAGE", "AIR_POLLUTION_CONTROL", "WATER_POLLUTION_CONTROL_EQUIPMENT", "WATER_AND_WASTEWATER_CLARIFICATION_AND_MIXING_EQUIPMENT", "WATER_AND_WASTEWATER_ADVANCED_TREATMENT_EQUIPMENT", "STRUCTURAL_METAL_FRAMING", "STRUCTURAL_PLASTICS", "TILING", "FACILITY_ELECTRICAL_POWER_GENERATING_AND_STORING_EQUIPMENT", "ELECTRICAL_UTILITIES", "ELECTRICAL_POWER_GENERATION", "ELECTRICAL_POWER_GENERATION_EQUIPMENT" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityOffice":{ "title":"ApiEntityOffice", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "officeName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the office.", "exampleSetFlag":false, "types":[ "string" ] }, "isCorporateOffice":{ "type":"boolean", "description":"Indicates if the office is the headquarters of the company.", "exampleSetFlag":false, "types":[ "boolean" ] }, "orgOfficeId":{ "type":"integer", "description":"The unique identifier of the organization of the office.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"The geographical coordinate for the longitude of the location.
                                                                                              The default format for longitude is decimal degrees, but the format you need to use will depend on your geolocation service.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"The geographical coordinate for the latitude of the location.
                                                                                              The default format for latitude is decimal degrees, but the format you need to use will depend on your geolocation service.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "distance":{ "type":"number", "description":"The distance the company is willing to travel for the project from this office.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "distanceMetric":{ "type":"string", "description":"The distance measure to be used. Valid options include kilometer and mile.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "KILOMETERS", "MILES" ] }, "officeId":{ "type":"integer", "description":"The unique identifier of an office.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyId":{ "type":"integer", "description":"The unique identifier for the company.The company object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "officeCountryCode":{ "maxLength":200, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "officePostalCode":{ "maxLength":200, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine1":{ "maxLength":200, "type":"string", "description":"The first line of the address of a location.
                                                                                              This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "type":"string", "description":"The second line of the address of a location.
                                                                                              This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "type":"string", "description":"The name of the city for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "fax":{ "maxLength":32, "type":"string", "description":"The fax number for the office.", "exampleSetFlag":false, "types":[ "string" ] }, "phone":{ "maxLength":32, "type":"string", "description":"The phone number for the office.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedCompany":{ "title":"ApiEntityExternallySourcedCompany", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "companyEnterpriseCertifications":{ "type":"array", "description":"List of enterprise certifications held by the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyEnterpriseCertification", "exampleSetFlag":false }, "types":[ "array" ] }, "companyWorkTypes":{ "type":"array", "description":"List of types of work or specialties of the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyWorkType", "exampleSetFlag":false }, "types":[ "array" ] }, "companyLaborTypes":{ "type":"array", "description":"List of labor union types applicable for the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyLaborType", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information about the company.", "exampleSetFlag":false, "types":[ "string" ] }, "businessRoleTypes":{ "type":"array", "description":"The business types for a company.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ARCHITECT", "ARCHITECT_ENGINEER", "CONSTRUCTION_MANAGER", "CONSULTANT", "CONTRACTOR", "CUSTOMER", "DESIGN_CONSULTANT", "DEVELOPER", "ENGINEER", "HEAD_CONTRACTOR", "OTHER", "OWNER", "OWNER_REP", "PROJECT_MANAGER", "QUANTITY_SURVEYOR", "RESELLER", "SUB_CONTRACTOR", "SUPPLIER", "VENDOR" ] }, "types":[ "array" ] }, "isTenantOwned":{ "type":"boolean", "description":"Indicates whether or not the company is an application tenant.", "exampleSetFlag":false, "types":[ "boolean" ] }, "sourceSiteId":{ "maxLength":255, "type":"string", "description":"The unique identifier of a company site in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "organizationId":{ "type":"integer", "description":"The unique identifier for the organization.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "qualificationStatus":{ "type":"string", "description":"Qualification status of a Company according to the tenant", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CONDITIONALLY_QUALIFIED", "NOT_QUALIFIED", "NO_STATUS", "QUALIFIED" ] }, "performanceRating":{ "type":"string", "description":"Performance Rating of a Company determined by the tenant.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NO_PERFORMANCE_RATING", "PERFORMANCE_LEVEL_FIVE", "PERFORMANCE_LEVEL_FOUR", "PERFORMANCE_LEVEL_THREE", "PERFORMANCE_LEVEL_TWO", "PERFORMANCE_LEVEL_ONE" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "distance":{ "type":"number", "description":"The distance the company is willing to travel for the project from the corporate office.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "distanceMetric":{ "type":"string", "description":"The distance measure to be used for corporate office distance. Valid options include kilometer and mile.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "KILOMETERS", "MILES" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of company data in an external source.", "example":"coarse", "exampleSetFlag":true, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the company's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The workspace that the company was created in. All changes to the company must be made in the owning workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"The latitude of a company.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                              This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                              This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the company. Valid values are Active and Inactive.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "url":{ "maxLength":255, "minLength":0, "type":"string", "description":"The website of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "offices":{ "type":"array", "description":"Offices associated with the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityOffice", "exampleSetFlag":false }, "types":[ "array" ] }, "fax":{ "maxLength":32, "minLength":0, "type":"string", "description":"The fax number for the company.", "exampleSetFlag":false, "types":[ "string" ] }, "phone":{ "maxLength":32, "minLength":0, "type":"string", "description":"The phone number for the company.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCompanyConfiguredFieldValueInput":{ "title":"ApiEntityCompanyConfiguredFieldValueInput", "type":"object", "properties":{ "companyConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the company configured field. This value should not be provided in create operation request data; however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":1000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CompanyConfiguredFieldValue object, a unique CompanyConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                              • companyConfiguredFieldValueId
                                                                                              • columnDefinitionId
                                                                                              • columnName
                                                                                              • columnLabel
                                                                                                • ", "exampleSetFlag":false }, "ApiEntityCompanyEnterpriseCertificationInput":{ "title":"ApiEntityCompanyEnterpriseCertificationInput", "type":"object", "properties":{ "companyEnterpriseCertificationTypeName":{ "type":"string", "description":"Enterprise Certifications held by the Company", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DISABLED_VETERAN_BUSINESS_ENTERPRISE_DVBE", "DISADVANTAGED_BUSINESS_ENTERPRISE_DBE", "EIGHT_A_BUSINESS", "SMALL_BUSINESS_ENTERPRISE_SBE", "UNDERUTILIZED_BUSINESS_HUB", "WOMEN_BUSINESS_ENTERPRISE_WBE", "MINORITY_BUSINESS_ENTERPRISE_MBE" ] }, "certificationId":{ "type":"integer", "description":"A unique identifier for the enterprise certification held by the company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCompanyLaborTypeInput":{ "title":"ApiEntityCompanyLaborTypeInput", "type":"object", "properties":{ "laborTypeAssociationId":{ "type":"integer", "description":"A unique identifier for labor type applicable for the company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyLaborTypeName":{ "type":"string", "description":"Labor union types applicable for the Company", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NON_UNION", "PREVAILING_WAGE", "UNION" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCompanyWorkTypeInput":{ "title":"ApiEntityCompanyWorkTypeInput", "type":"object", "properties":{ "workTypeId":{ "type":"integer", "description":"A unique identifier for type of work of the company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workTypeName":{ "type":"string", "description":"Types of Work or Specialties of the Company", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROCUREMENT_AND_CONTRACTING_REQUIREMENTS", "SOLICITATION", "INSTRUCTIONS_FOR_PROCUREMENT", "AVAILABLE_INFORMATION", "PROCUREMENT_FORMS_AND_SUPPLEMENTS", "CONTRACTING_FORMS_AND_SUPPLEMENTS", "PROJECT_FORMS", "CONDITIONS_OF_THE_CONTRACT", "REVISIONS_CLARIFICATIONS_AND_MODIFICATIONS", "SUMMARY", "ADMINISTRATIVE_REQUIREMENTS", "QUALITY_REQUIREMENTS", "TEMPORARY_FACILITIES_AND_CONTROLS", "PRODUCT_REQUIREMENTS", "EXECUTION_AND_CLOSEOUT_REQUIREMENTS", "PERFORMANCE_REQUIREMENTS", "LIFE_CYCLE_ACTIVITIES", "EXISTING_CONDITIONS", "ASSESSMENT", "SUBSURFACE_INVESTIGATION", "DEMOLITION_AND_STRUCTURE_MOVING", "SITE_REMEDIATION", "CONTAMINATED_SITE_MATERIAL_REMOVAL", "FACILITY_REMEDIATION", "CONCRETE", "CONCRETE_FORMING_AND_ACCESSORIES", "CONCRETE_REINFORCING", "CAST_IN_PLACE_CONCRETE", "CAST_DECKS_AND_UNDERLAYMENT", "GROUTING", "MASS_CONCRETE", "CONCRETE_CUTTING_AND_BORING", "MASONRY", "UNIT_MASONRY", "STONE_ASSEMBLIES", "REFRACTORY_MASONRY", "CORROSION_RESISTANT_MASONRY", "MANUFACTURED_MASONRY", "METALS", "METAL_DECKING", "COLD_FORMED_METAL_FRAMING", "METAL_FABRICATIONS", "DECORATIVE_METAL", "WOOD_PLASTICS_AND_COMPOSITES", "ROUGH_CARPENTRY", "ARCHITECTURAL_WOODWORK", "PLASTIC_FABRICATIONS", "STRUCTURAL_COMPOSITES", "COMPOSITE_FABRICATIONS", "THERMAL_AND_MOISTURE_PROTECTION", "DAMPPROOFING_AND_WATERPROOFING", "THERMAL_PROTECTION", "ROOFING_AND_SIDING_PANELS", "MEMBRANE_ROOFING", "FLASHING_AND_SHEET_METAL", "ROOF_AND_WALL_SPECIALTIES_AND_ACCESSORIES", "FIRE_AND_SMOKE_PROTECTION", "JOINT_PROTECTION", "OPENINGS", "DOORS_AND_FRAMES", "SPECIALTY_DOORS_AND_FRAMES", "ENTRANCES_STOREFRONTS_AND_CURTAIN_WALLS", "WINDOWS", "ROOF_WINDOWS_AND_SKYLIGHTS", "HARDWARE", "GLAZING", "LOUVERS_AND_VENTS", "FINISHES", "PLASTER_AND_GYPSUM_BOARD", "SPECIALIZED_SYSTEMS", "CEILINGS", "FLOORING", "ACOUSTIC_TREATMENT", "PAINTING_AND_COATING", "SPECIALTIES", "INFORMATION_SPECIALTIES", "FIREPLACES_AND_STOVES", "SAFETY_SPECIALTIES", "STORAGE_SPECIALTIES", "OTHER_SPECIALTIES", "EQUIPMENT", "VEHICLE_AND_PEDESTRIAN_EQUIPMENT", "COMMERCIAL_EQUIPMENT", "RESIDENTIAL_EQUIPMENT", "FOODSERVICE_EQUIPMENT", "EDUCATIONAL_AND_SCIENTIFIC_EQUIPMENT", "HEALTHCARE_EQUIPMENT", "FACILITY_MAINTENANCE_AND_OPERATION_EQUIPMENT", "OTHER_EQUIPMENT", "FURNISHINGS", "ART", "WINDOW_TREATMENTS", "CASEWORK", "FURNISHINGS_AND_ACCESSORIES", "FURNITURE", "OTHER_FURNISHINGS", "SPECIAL_CONSTRUCTION", "SPECIAL_FACILITY_COMPONENTS", "SPECIAL_PURPOSE_ROOMS", "SPECIAL_STRUCTURES", "INTEGRATED_CONSTRUCTION", "LIFTS", "DUMBWAITERS", "ELEVATORS", "ESCALATORS_AND_MOVING_WALKS", "TURNTABLES", "SCAFFOLDING", "FIRE_SUPPRESSION", "WATER_BASED_FIRE_SUPPRESSION_SYSTEMS", "FIRE_EXTINGUISHING_SYSTEMS", "FIRE_PUMPS", "FIRE_SUPPRESSION_WATER_STORAGE", "PLUMBING", "PLUMBING_PIPING", "PLUMBING_EQUIPMENT", "PLUMBING_FIXTURES", "POOL_AND_FOUNTAIN_PLUMBING_SYSTEMS", "GAS_AND_VACUUM_SYSTEMS_FOR_LABORATORY_AND_HEALTHCARE", "HEATING_VENTILATING_AND_AIR_CONDITIONING_HVAC", "FACILITY_FUEL_SYSTEMS", "HVAC_PIPING_AND_PUMPS", "HVAC_AIR_DISTRIBUTION", "HVAC_AIR_CLEANING_DEVICES", "CENTRAL_HEATING_EQUIPMENT", "CENTRAL_COOLING_EQUIPMENT", "CENTRAL_HVAC_EQUIPMENT", "DECENTRALIZED_HVAC_EQUIPMENT", "INTEGRATED_AUTOMATION", "INTEGRATED_AUTOMATION_NETWORK_EQUIPMENT", "INTEGRATED_AUTOMATION_INSTRUMENTATION_AND_TERMINAL_DEVICES", "PROCESS_CONTROL_AND_ENTERPRISE_MANAGEMENT_SYSTEMS", "INTEGRATED_AUTOMATION_FACILITY_CONTROLS", "INTEGRATED_AUTOMATION_CONTROL_SEQUENCES", "ELECTRICAL", "MEDIUM_VOLTAGE_ELECTRICAL_DISTRIBUTION", "LOW_VOLTAGE_ELECTRICAL_DISTRIBUTION", "WELLS", "LIGHTING", "COMMUNICATIONS", "STRUCTURED_CABLING", "DATA_COMMUNICATIONS", "VOICE_COMMUNICATIONS", "AUDIO_VIDEO_COMMUNICATIONS", "DISTRIBUTED_COMMUNICATIONS_AND_MONITORING_SYSTEMS", "ACCESS_CONTROL", "VIDEO_SURVEILLANCE", "SECURITY_DETECTION_ALARM_AND_MONITORING", "INSTRUMENTATION_FOR_PROCESS_SYSTEMS", "EARTHWORK", "SITE_CLEARING", "EARTH_MOVING", "EARTHWORK_METHODS", "SHORING_AND_UNDERPINNING", "BASES_BALLASTS_AND_PAVING", "SITE_IMPROVEMENTS", "WETLANDS", "IRRIGATION", "PLANTING", "UTILITIES", "WATER_UTILITIES", "SANITARY_SEWERAGE", "COMMUNICATIONS_UTILITIES", "TRANSPORTATION", "GUIDEWAYS_RAILWAYS", "TRACTION_POWER", "TRANSPORTATION_FARE_COLLECTION_EQUIPMENT", "BRIDGES", "WATERWAY_AND_MARINE_CONSTRUCTION", "WATERWAY_AND_MARINE_CONSTRUCTION_AND_EQUIPMENT", "COASTAL_CONSTRUCTION", "MARINE_CONSTRUCTION_AND_EQUIPMENT", "DAM_CONSTRUCTION_AND_EQUIPMENT", "PROCESS_INTERCONNECTIONS", "LIQUIDS_PROCESS_PIPING", "SOLID_AND_MIXED_MATERIALS_PIPING_AND_CHUTES", "COMMISSIONING_OF_PROCESS_SYSTEMS", "PRIMARY_CONTROL_DEVICES", "MATERIAL_PROCESSING_AND_HANDLING_EQUIPMENT", "PIECE_MATERIAL_HANDLING_EQUIPMENT", "MANUFACTURING_EQUIPMENT", "CONTAINER_PROCESSING_AND_PACKAGING", "MATERIAL_STORAGE", "MOBILE_PLANT_EQUIPMENT", "PROCESS_HEATING_COOLING_AND_DRYING_EQUIPMENT", "PROCESS_HEATING_EQUIPMENT", "PROCESS_COOLING_EQUIPMENT", "PROCESS_DRYING_EQUIPMENT", "GAS_HANDLING_EQUIPMENT", "LIQUID_HANDLING_EQUIPMENT", "GAS_AND_LIQUID_PURIFICATION_EQUIPMENT", "GAS_AND_LIQUID_STORAGE", "POLLUTION_AND_WASTE_CONTROL_EQUIPMENT", "NOISE_POLLUTION_CONTROL", "ODOR_CONTROL", "SOLID_WASTE_CONTROL_AND_REUSE", "WASTE_THERMAL_PROCESSING_EQUIPMENT", "INDUSTRY_SPECIFIC_MANUFACTURING_EQUIPMENT", "USER_DEFINED_TEXTILES_AND_APPAREL_MANUFACTURING_EQUIPMENT", "WATER_AND_WASTEWATER_EQUIPMENT", "WATER_AND_WASTEWATER_PRELIMINARY_TREATMENT_EQUIPMENT", "WATER_AND_WASTEWATER_CHEMICAL_FEED_EQUIPMENT", "WATER_AND_WASTEWATER_SECONDARY_TREATMENT_EQUIPMENT", "WATER_AND_WASTEWATER_RESIDUALS_HANDLING_AND_TREATMENT", "ELECTRICAL_POWER_GENERATION_TESTING", "USER_DEFINED_PETROLEUM_AND_COAL_PRODUCTS_MANUFACTURING", "USER_DEFINED_FABRICATED_METAL_PRODUCT_MANUFACTURING", "USER_DEFINED_FURNITURE_AND_RELATED_PRODUCT_MANUFACTURING", "COMBINED_HEAT_AND_POWER_GENERATION", "GENERAL_REQUIREMENTS", "PRICE_AND_PAYMENT_PROCEDURES", "WATER_REMEDIATION", "PRECAST_CONCRETE", "METAL_JOISTS", "FINISH_CARPENTRY", "STEEP_SLOPE_ROOFING", "WALL_FINISHES", "INTERIOR_SPECIALTIES", "EXTERIOR_SPECIALTIES", "ENTERTAINMENT_AND_RECREATION_EQUIPMENT", "MULTIPLE_SEATING", "SPECIAL_INSTRUMENTATION", "CONVEYING_EQUIPMENT", "OTHER_CONVEYING_EQUIPMENT", "ELECTRICAL_PROTECTION", "ELECTRONIC_SAFETY_AND_SECURITY", "LIFE_SAFETY", "EXCAVATION_SUPPORT_AND_PROTECTION", "SPECIAL_FOUNDATIONS_AND_LOAD_BEARING_ELEMENTS", "TUNNELING_AND_MINING", "EXTERIOR_IMPROVEMENTS", "STORMWATER_UTILITIES", "HYDROCARBON_UTILITIES", "HYDRONIC_AND_STEAM_ENERGY_UTILITIES", "TRANSPORTATION_SIGNALING_AND_CONTROL_EQUIPMENT", "TRANSPORTATION_CONSTRUCTION_AND_EQUIPMENT", "WATERWAY_AND_MARINE_SIGNALING_AND_CONTROL_EQUIPMENT", "WATERWAY_CONSTRUCTION_AND_EQUIPMENT", "GAS_AND_VAPOR_PROCESS_PIPING_AND_DUCTWORK", "PROCESS_PIPING_AND_EQUIPMENT_PROTECTION", "BULK_MATERIAL_PROCESSING_EQUIPMENT", "PROCESS_GAS_AND_LIQUID_HANDLING_PURIFICATION_AND_STORAGE", "AIR_POLLUTION_CONTROL", "WATER_POLLUTION_CONTROL_EQUIPMENT", "WATER_AND_WASTEWATER_CLARIFICATION_AND_MIXING_EQUIPMENT", "WATER_AND_WASTEWATER_ADVANCED_TREATMENT_EQUIPMENT", "STRUCTURAL_METAL_FRAMING", "STRUCTURAL_PLASTICS", "TILING", "FACILITY_ELECTRICAL_POWER_GENERATING_AND_STORING_EQUIPMENT", "ELECTRICAL_UTILITIES", "ELECTRICAL_POWER_GENERATION", "ELECTRICAL_POWER_GENERATION_EQUIPMENT" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedCompanyInput":{ "title":"ApiEntityExternallySourcedCompanyInput", "required":[ "cityName", "companyName", "countryCode", "postalCode", "stateName" ], "type":"object", "properties":{ "companyEnterpriseCertifications":{ "type":"array", "description":"List of enterprise certifications held by the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyEnterpriseCertificationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "companyWorkTypes":{ "type":"array", "description":"List of types of work or specialties of the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyWorkTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "companyLaborTypes":{ "type":"array", "description":"List of labor union types applicable for the company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyLaborTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information about the company.", "exampleSetFlag":false, "types":[ "string" ] }, "businessRoleTypes":{ "type":"array", "description":"The business types for a company.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ARCHITECT", "ARCHITECT_ENGINEER", "CONSTRUCTION_MANAGER", "CONSULTANT", "CONTRACTOR", "CUSTOMER", "DESIGN_CONSULTANT", "DEVELOPER", "ENGINEER", "HEAD_CONTRACTOR", "OTHER", "OWNER", "OWNER_REP", "PROJECT_MANAGER", "QUANTITY_SURVEYOR", "RESELLER", "SUB_CONTRACTOR", "SUPPLIER", "VENDOR" ] }, "types":[ "array" ] }, "sourceSiteId":{ "maxLength":255, "type":"string", "description":"The unique identifier of a company site in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "organizationId":{ "type":"integer", "description":"The unique identifier for the organization.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "qualificationStatus":{ "type":"string", "description":"Qualification status of a Company according to the tenant", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CONDITIONALLY_QUALIFIED", "NOT_QUALIFIED", "NO_STATUS", "QUALIFIED" ] }, "performanceRating":{ "type":"string", "description":"Performance Rating of a Company determined by the tenant.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NO_PERFORMANCE_RATING", "PERFORMANCE_LEVEL_FIVE", "PERFORMANCE_LEVEL_FOUR", "PERFORMANCE_LEVEL_THREE", "PERFORMANCE_LEVEL_TWO", "PERFORMANCE_LEVEL_ONE" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of company data in an external source.", "example":"coarse", "exampleSetFlag":true, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"The latitude of a company.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a company.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCompanyConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the company. Valid values are Active and Inactive.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "url":{ "maxLength":255, "minLength":0, "type":"string", "description":"The website of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "fax":{ "maxLength":32, "minLength":0, "type":"string", "description":"The fax number for the company.", "exampleSetFlag":false, "types":[ "string" ] }, "phone":{ "maxLength":32, "minLength":0, "type":"string", "description":"The phone number for the company.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ExternallySourcedCompany object, a unique ExternallySourcedCompany object can be identified by the following combinations of the fields.
                                                                                                • companyId
                                                                                                • companyName,postalCode,countryCode
                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityColumnDefinition":{ "title":"ApiEntityColumnDefinition", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "listValues":{ "type":"array", "description":"The list of available values for a List type configured field.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFlexListValue", "exampleSetFlag":false }, "types":[ "array" ] }, "dataLength":{ "maximum":9999, "minimum":0, "type":"integer", "description":"The length of a configured field. Editable only for Text type fields. ", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "localizedColumnDefinitions":{ "type":"array", "description":"The list of column labels per locale for the configured field.
                                                                                                  The configured field label you enter will be the default label for all locales. You can update the field label for each locale using the localizedColumnDefinitions. You will not need to re-enter the label for your locale in the array.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityColumnDefinitionLocalization", "exampleSetFlag":false }, "types":[ "array" ] }, "flexType":{ "type":"string", "description":"The type of a flex object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "CAPITAL_PLAN_COST", "CAPITAL_PLAN_OTHER", "CAPITAL_PLAN_TEXT", "COMPANY", "CUSTOM_LOG", "DOCUMENT_COST", "DOCUMENT_OTHER", "DOCUMENT_TEXT", "FUND", "IDEA", "PORTFOLIO", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RESOURCE_ASSIGNMENT", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] }, "dataType":{ "type":"string", "description":"The data type of a configured field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FT_DATE", "FT_MONEY", "FT_MONEY_NO_MC", "FT_TEXT", "FT_INT", "FT_FLOAT_2_DECIMALS", "FT_LIST", "FT_BOOLEAN" ] }, "udfFormula":{ "type":"string", "description":"Maximum Length: 2,147,483,647
                                                                                                  The formula of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "viewColumnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The view column name of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "restricted":{ "type":"boolean", "description":"The field to make a configured field restricted.", "exampleSetFlag":false, "types":[ "boolean" ] }, "summaryCalculationType":{ "type":"string", "description":"Specifies how the field should be calculated for a grouped row in a view.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUM", "AVERAGE", "MIN", "MAX", "FORMULA", "NONE", "MAX_NULL", "NULLABLE_SUM" ] }, "flexObject":{ "type":"string", "description":"Flex Object to be saved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "DOCUMENT", "FUND", "IDEA", "PORTFOLIO", "PROGRAM", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "STRATEGY", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] }, "physicalType":{ "type":"string", "description":"The physical percent complete of a configured field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DATE", "NUMBER", "STRING" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the configured field and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "label":{ "maxLength":100, "minLength":1, "type":"string", "description":"The label of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"The status of a configured field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ENABLED", "UPDATED", "DISABLED", "DELETED", "PENDING", "FAILED" ] }, "udfType":{ "type":"string", "description":"The type of a configured field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "FORMULA" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityColumnDefinitionLocalization":{ "title":"ApiEntityColumnDefinitionLocalization", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionLocalizationId":{ "type":"integer", "description":"The unique identifier of a configured field locale label.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "languageCode":{ "maxLength":6, "type":"string", "description":"The language code for the locale.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "en", "es", "de", "ja", "zh_CN", "zh_TW", "pt_BR", "fr", "ru", "it", "ko", "nl" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The localized label of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFlexListValue":{ "title":"ApiEntityFlexListValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "listValueId":{ "type":"integer", "description":"The unique identifier for the list value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "listKey":{ "maxLength":128, "minLength":0, "type":"string", "description":"List key for field of type list.", "exampleSetFlag":false, "types":[ "string" ] }, "localizedListValues":{ "type":"array", "description":"The unique identifier for the list value.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityListValueNM", "exampleSetFlag":false }, "types":[ "array" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityListValueNM":{ "title":"ApiEntityListValueNM", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "listValueNMId":{ "type":"integer", "description":"The unique identifier for the list value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "languageCode":{ "maxLength":6, "minLength":0, "type":"string", "description":"Language code.", "exampleSetFlag":false, "types":[ "string" ] }, "displayValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"List display value for language code.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityColumnDefinitionInput":{ "title":"ApiEntityColumnDefinitionInput", "required":[ "dataType", "flexObject", "label", "viewColumnName", "workspaceId" ], "type":"object", "properties":{ "listValues":{ "type":"array", "description":"The list of available values for a List type configured field.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFlexListValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "dataLength":{ "maximum":9999, "minimum":0, "type":"integer", "description":"The length of a configured field. Editable only for Text type fields. ", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "localizedColumnDefinitions":{ "type":"array", "description":"The list of column labels per locale for the configured field.
                                                                                                  The configured field label you enter will be the default label for all locales. You can update the field label for each locale using the localizedColumnDefinitions. You will not need to re-enter the label for your locale in the array.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityColumnDefinitionLocalizationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "flexType":{ "type":"string", "description":"The type of a flex object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "CAPITAL_PLAN_COST", "CAPITAL_PLAN_OTHER", "CAPITAL_PLAN_TEXT", "COMPANY", "CUSTOM_LOG", "DOCUMENT_COST", "DOCUMENT_OTHER", "DOCUMENT_TEXT", "FUND", "IDEA", "PORTFOLIO", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RESOURCE_ASSIGNMENT", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] }, "dataType":{ "type":"string", "description":"The data type of a configured field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FT_DATE", "FT_MONEY", "FT_MONEY_NO_MC", "FT_TEXT", "FT_INT", "FT_FLOAT_2_DECIMALS", "FT_LIST", "FT_BOOLEAN" ] }, "udfFormula":{ "type":"string", "description":"Maximum Length: 2,147,483,647
                                                                                                  The formula of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "viewColumnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The view column name of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "restricted":{ "type":"boolean", "description":"The field to make a configured field restricted.", "exampleSetFlag":false, "types":[ "boolean" ] }, "summaryCalculationType":{ "type":"string", "description":"Specifies how the field should be calculated for a grouped row in a view.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUM", "AVERAGE", "MIN", "MAX", "FORMULA", "NONE", "MAX_NULL", "NULLABLE_SUM" ] }, "flexObject":{ "type":"string", "description":"Flex Object to be saved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "DOCUMENT", "FUND", "IDEA", "PORTFOLIO", "PROGRAM", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "STRATEGY", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] }, "physicalType":{ "type":"string", "description":"The physical percent complete of a configured field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DATE", "NUMBER", "STRING" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "label":{ "maxLength":100, "minLength":1, "type":"string", "description":"The label of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"The status of a configured field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ENABLED", "UPDATED", "DISABLED", "DELETED", "PENDING", "FAILED" ] }, "udfType":{ "type":"string", "description":"The type of a configured field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "FORMULA" ] } }, "description":"This entity represents a ColumnDefinition object, a unique ColumnDefinition object can be identified by the following combinations of the fields.
                                                                                                  • columnDefinitionId
                                                                                                  • flexObject,label,workspaceId
                                                                                                  • flexObject,viewColumnName,workspaceId
                                                                                                  • flexObject,label,workspaceCode
                                                                                                  • flexObject,viewColumnName,workspaceCode
                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityColumnDefinitionLocalizationInput":{ "title":"ApiEntityColumnDefinitionLocalizationInput", "required":[ "columnLabel", "languageCode" ], "type":"object", "properties":{ "columnDefinitionLocalizationId":{ "type":"integer", "description":"The unique identifier of a configured field locale label.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "languageCode":{ "maxLength":6, "type":"string", "description":"The language code for the locale.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "en", "es", "de", "ja", "zh_CN", "zh_TW", "pt_BR", "fr", "ru", "it", "ko", "nl" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The localized label of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityFlexListValueInput":{ "title":"ApiEntityFlexListValueInput", "type":"object", "properties":{ "listValueId":{ "type":"integer", "description":"The unique identifier for the list value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "listKey":{ "maxLength":128, "minLength":0, "type":"string", "description":"List key for field of type list.", "exampleSetFlag":false, "types":[ "string" ] }, "localizedListValues":{ "type":"array", "description":"The unique identifier for the list value.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityListValueNMInput", "exampleSetFlag":false }, "types":[ "array" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityListValueNMInput":{ "title":"ApiEntityListValueNMInput", "type":"object", "properties":{ "listValueNMId":{ "type":"integer", "description":"The unique identifier for the list value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "languageCode":{ "maxLength":6, "minLength":0, "type":"string", "description":"Language code.", "exampleSetFlag":false, "types":[ "string" ] }, "displayValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"List display value for language code.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityConfiguredFieldMoveRequestInput":{ "title":"ApiEntityConfiguredFieldMoveRequestInput", "type":"object", "properties":{ "objectType":{ "type":"string", "description":"This is a required field for PROGRAM, IDEA, STRATEGY, and DOCUMENT object types.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DOCUMENT", "IDEA", "PROGRAM", "STRATEGY" ] }, "owningWorkspaceCode":{ "type":"string", "description":"The user-specified identifier of the workspace that currently owns the configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "targetWorkspaceId":{ "type":"integer", "description":"The system-generated identifier of the target workspace to which ownership of the configured field is moved.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "targetWorkspaceCode":{ "type":"string", "description":"The user-specified identifier of the target workspace to which ownership of the configured field is moved.", "exampleSetFlag":false, "types":[ "string" ] }, "owningWorkspaceId":{ "type":"integer", "description":"The system-generated identifier of the workspace that currently owns the configured field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "viewColumnName":{ "type":"string", "description":"The view column name of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"The system-generated identifier of a configured field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ConfiguredFieldMoveRequest object, a unique ConfiguredFieldMoveRequest object can be identified by the following combinations of the fields.
                                                                                                    • columnDefinitionId,targetWorkspaceId
                                                                                                    • columnDefinitionId,targetWorkspaceCode
                                                                                                    • viewColumnName,owningWorkspaceId,targetWorkspaceId
                                                                                                    • viewColumnName,owningWorkspaceCode,targetWorkspaceCode
                                                                                                    • columnDefinitionId,targetWorkspaceId,objectType
                                                                                                    • columnDefinitionId,targetWorkspaceCode,objectType
                                                                                                    • viewColumnName,owningWorkspaceId,targetWorkspaceId,objectType
                                                                                                    • viewColumnName,owningWorkspaceCode,targetWorkspaceCode,objectType
                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityColumnDefinitionSortInput":{ "title":"ApiEntityColumnDefinitionSortInput", "type":"object", "properties":{ "sortOrder":{ "type":"string", "description":"The order in which the list values needs to be alpha-numerically sorted. Order default to ASCENDING if no value is provided in request.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ASCENDING", "DESCENDING" ] }, "viewColumnName":{ "type":"string", "description":"The view column name of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "flexObject":{ "type":"string", "description":"Flex Object to be saved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "DOCUMENT", "FUND", "IDEA", "PORTFOLIO", "PROGRAM", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "STRATEGY", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "label":{ "type":"string", "description":"The label of a configured field.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityColumnDefinitionLabelInput":{ "title":"ApiEntityColumnDefinitionLabelInput", "required":[ "flexObject", "inheritedWorkspaceId", "viewColumnName" ], "type":"object", "properties":{ "localizedColumnDefinitions":{ "type":"array", "description":"The list of column labels per locale for the configured field.
                                                                                                      The configured field label you enter will be the default label for all locales. You can update the field label for each locale using the localizedColumnDefinitions. You will not need to re-enter the label for your locale in the array.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityColumnDefinitionLocalizationInput", "exampleSetFlag":false }, "types":[ "array" ] }, "inheritedWorkspaceId":{ "type":"integer", "description":"The system-generated identifier for the inherited workspace where the localized column label of the configured field needs to be updated.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "inheritedWorkspaceCode":{ "type":"string", "description":"The user-specified identifier for the inherited workspace where the localized column label of the configured field needs to be updated.", "exampleSetFlag":false, "types":[ "string" ] }, "owningWorkspaceCode":{ "type":"string", "description":"The user-specified identifier of the workspace that currently owns the configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "owningWorkspaceId":{ "type":"integer", "description":"The system-generated identifier of the workspace that currently owns the configured field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "viewColumnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The view column name of a configured field.", "exampleSetFlag":false, "types":[ "string" ] }, "flexObject":{ "type":"string", "description":"Flex Object to be saved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "ASSIGNMENT", "BUDGET_CHANGE", "BUDGET_ITEM", "BUDGET_TRANSACTION", "BUDGET_TRANSFER", "COMPANY", "CUSTOM_LOG", "FUND", "PORTFOLIO", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGES", "PROGRAM_BUDGET_TRANSACTIONS", "PROGRAM_BUDGET_TRANSFERS", "PROJECT", "PROJECT_ACTUALS", "PROJECT_COST_SHEET", "RISK", "SCOPE_ITEM", "SCOPE_ITEM_ASSIGNMENT", "WBS", "WORK_MANAGER_TASK", "WORK_PACKAGE", "WORKSPACE_COST_SHEET" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ColumnDefinitionLabel object, a unique ColumnDefinitionLabel object can be identified by the following combinations of the fields.
                                                                                                      • columnDefinitionId,inheritedWorkspaceId
                                                                                                      • columnDefinitionId,inheritedWorkspaceCode
                                                                                                      • viewColumnName,owningWorkspaceId,inheritedWorkspaceId
                                                                                                      • viewColumnName,owningWorkspaceId,inheritedWorkspaceCode
                                                                                                      • viewColumnName,owningWorkspaceCode,inheritedWorkspaceId
                                                                                                      • viewColumnName,owningWorkspaceCode,inheritedWorkspaceCode
                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityCodeValueConstraint":{ "title":"ApiEntityCodeValueConstraint", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueConstraintId":{ "type":"integer", "description":"The unique identifier of a code value of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "constraintId":{ "type":"integer", "description":"The unique identifier of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityConstraint":{ "title":"ApiEntityConstraint", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "constraintCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user specified identifier for a constraint.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The system-generated unique identifier of the company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "constraintName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a constraint.", "exampleSetFlag":false, "types":[ "string" ] }, "dateIdentified":{ "type":"string", "description":"The date the constraint was first identified as an impediment to completing a task.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "dateNeeded":{ "type":"string", "description":"The date the constraint needs to be resolved by to prevent a delay in the completion of the tasks or task milestones that are dependent on it.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "promisedDate":{ "type":"string", "description":"The date by which the responsible party has agreed to resolve the constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "deliveredDate":{ "type":"string", "description":"The date the responsible party actually resolved the constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyPostalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyColor":{ "maxLength":6, "minLength":1, "type":"string", "description":"The selected color representation of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "taskConstraints":{ "type":"array", "description":"List of work manager task constraints.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityTaskConstraint", "exampleSetFlag":false }, "types":[ "array" ] }, "constraintType":{ "type":"string", "description":"The type of constraint.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACCESS", "DESIGN_ISSUE", "DOCUMENTS", "EQUIPMENT", "LABOR_CREWS", "MATERIALS", "QA_QC" ] }, "constraintId":{ "type":"integer", "description":"The unique identifier of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a constraint. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueConstraint", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of the constraint.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of the constraint.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a constraint.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityConstraintConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the task constraint. Valid values are Not Planned, Planned, and Delivered.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_PLANNED", "PLANNED", "DELIVERED" ] }, "userId":{ "type":"integer", "description":"The unique identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notes":{ "maxLength":0, "type":"string", "description":"The Notes on the constraint. ", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityConstraintConfiguredFieldValue":{ "title":"ApiEntityConstraintConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "constraintUdfValueId":{ "type":"integer", "description":"The system-generated unique identifier of the Constraint Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "constraintId":{ "type":"integer", "description":"The unique identifier of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityTaskConstraint":{ "title":"ApiEntityTaskConstraint", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "taskConstraintId":{ "type":"integer", "description":"The unique identifier of a work manager task constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskId":{ "type":"integer", "description":"The unique identifier of a task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "constraintId":{ "type":"integer", "description":"The unique identifier of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueConstraintInput":{ "title":"ApiEntityCodeValueConstraintInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueConstraintId":{ "type":"integer", "description":"The unique identifier of a code value of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "constraintId":{ "type":"integer", "description":"The unique identifier of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueConstraint object, a unique CodeValueConstraint object can be identified by the following combinations of the fields.
                                                                                                        • codeValueConstraintId
                                                                                                        • codeValueId
                                                                                                        • codeTypeId,codeValueCode
                                                                                                        • codeTypeCode,codeValueCode
                                                                                                        • codeTypeCode,parentId,codeValueCode
                                                                                                        • codeValueCode,codeTypeId,parentId
                                                                                                        • codeTypeCode,codeValueCode,projectCode
                                                                                                        • codeTypeCode,codeValueCode,projectId
                                                                                                        • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                        • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityConstraintConfiguredFieldValueInput":{ "title":"ApiEntityConstraintConfiguredFieldValueInput", "type":"object", "properties":{ "constraintUdfValueId":{ "type":"integer", "description":"The system-generated unique identifier of the Constraint Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "constraintId":{ "type":"integer", "description":"The unique identifier of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ConstraintConfiguredFieldValue object, a unique ConstraintConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                          • constraintUdfValueId
                                                                                                          • columnDefinitionId
                                                                                                          • columnName
                                                                                                          • columnLabel
                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityConstraintInput":{ "title":"ApiEntityConstraintInput", "required":[ "constraintCode", "constraintName", "dateIdentified", "projectCompanyId", "projectId" ], "type":"object", "properties":{ "constraintCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user specified identifier for a constraint.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The system-generated unique identifier of the company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "constraintName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a constraint.", "exampleSetFlag":false, "types":[ "string" ] }, "dateIdentified":{ "type":"string", "description":"The date the constraint was first identified as an impediment to completing a task.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "dateNeeded":{ "type":"string", "description":"The date the constraint needs to be resolved by to prevent a delay in the completion of the tasks or task milestones that are dependent on it.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "promisedDate":{ "type":"string", "description":"The date by which the responsible party has agreed to resolve the constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "deliveredDate":{ "type":"string", "description":"The date the responsible party actually resolved the constraint.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyPostalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyColor":{ "maxLength":6, "minLength":1, "type":"string", "description":"The selected color representation of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "taskConstraints":{ "type":"array", "description":"List of work manager task constraints.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityTaskConstraintInput", "exampleSetFlag":false }, "types":[ "array" ] }, "constraintType":{ "type":"string", "description":"The type of constraint.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACCESS", "DESIGN_ISSUE", "DOCUMENTS", "EQUIPMENT", "LABOR_CREWS", "MATERIALS", "QA_QC" ] }, "constraintId":{ "type":"integer", "description":"The unique identifier of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a constraint. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueConstraintInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of the constraint.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of the constraint.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a constraint.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityConstraintConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userId":{ "type":"integer", "description":"The unique identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notes":{ "maxLength":0, "type":"string", "description":"The Notes on the constraint. ", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a Constraint object, a unique Constraint object can be identified by the following combinations of the fields.
                                                                                                            • constraintId
                                                                                                            • constraintCode,constraintName,projectId
                                                                                                            • constraintCode,constraintName,projectCode,workspaceCode
                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityTaskConstraintInput":{ "title":"ApiEntityTaskConstraintInput", "type":"object", "properties":{ "taskConstraintId":{ "type":"integer", "description":"The unique identifier of a work manager task constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskId":{ "type":"integer", "description":"The unique identifier of a task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "constraintId":{ "type":"integer", "description":"The unique identifier of a constraint.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a TaskConstraint object, a unique TaskConstraint object can be identified by the following combinations of the fields.
                                                                                                              • taskConstraintId
                                                                                                              • constraintId,workManagerTaskId
                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityCostCategory":{ "title":"ApiEntityCostCategory", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"The classification of the cost category.
                                                                                                                Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate.
                                                                                                                Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
                                                                                                                Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
                                                                                                                Other: Cost is manually entered as a lump sum.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LABOR", "EQUIPMENT", "MATERIALS", "OTHER" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "abbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviation for the cost category name.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the cost category and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of a cost category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCostCategoryInput":{ "title":"ApiEntityCostCategoryInput", "required":[ "abbreviation", "costCategoryName", "type", "workspaceId" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"The classification of the cost category.
                                                                                                                Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate.
                                                                                                                Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
                                                                                                                Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
                                                                                                                Other: Cost is manually entered as a lump sum.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LABOR", "EQUIPMENT", "MATERIALS", "OTHER" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "abbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviation for the cost category name.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of a cost category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a CostCategory object, a unique CostCategory object can be identified by the following combinations of the fields.
                                                                                                                • costCategoryId
                                                                                                                • abbreviation,costCategoryName,workspaceId
                                                                                                                • abbreviation,costCategoryName,workspaceCode
                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityCBSSheetCategoryRow":{ "title":"ApiEntityCBSSheetCategoryRow", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "costCategory":{ "type":"integer", "description":"The type of cost associated with the budget transfer line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "categoryRowId":{ "type":"integer", "description":"The unique identifier of a cost sheet row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedHours":{ "type":"number", "description":"The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
                                                                                                                  Calculated as Original Quantity multiplied by Original Productivity Rate.
                                                                                                                  Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"Calculated as the sum of all pending hour changes in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The sum of all approved change hours in the change and transfer records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "type":"number", "description":"Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "type":"number", "description":"The Revised Hours at the time the baseline was set.", "format":"double", "exampleSetFlag":false }, "etcHours":{ "type":"number", "description":"The estimated number of hours needed to complete the work.
                                                                                                                  Calculated as BAC Hours minus Earned Hours.", "format":"double", "exampleSetFlag":false }, "eacHours":{ "type":"number", "description":"Calculated as ETC Hours plus Actual Hours to Date.", "format":"double", "exampleSetFlag":false }, "earnedHours":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.", "format":"double", "exampleSetFlag":false }, "actualHoursToDate":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "bacHours":{ "type":"number", "description":"The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "remainingHours":{ "type":"number", "description":"The number of hours left for the scope assignment.
                                                                                                                  Calculated as Remaining Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false }, "installedHours":{ "type":"number", "description":"Hours spent on the scope assignment.
                                                                                                                  Calculated as Installed Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false }, "atCompletionHours":{ "type":"number", "description":"The total hours expected for the scope assignment.
                                                                                                                  Calculated as Revised Hours plus Adjusted Hours.", "format":"double", "exampleSetFlag":false }, "projectHPI":{ "type":"number", "description":"Calculated as the total of Project Earned Hours divided by Project Actual Hours.", "format":"double", "exampleSetFlag":false }, "projectActualHours":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "projectEarnedHours":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rowCost":{ "description":"The Cost Category Row service enables you to view cost category rows.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityCBSSheetCategoryRowCost" } ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSSheetCategoryRowCost":{ "title":"ApiEntityCBSSheetCategoryRowCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "pendingProjectActualsWorkspace1":{ "type":"number", "description":"The total amount of pending actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "pendingProjectActualsWorkspace2":{ "type":"number", "description":"The total amount of pending actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "pendingProjectActualsWorkspace3":{ "type":"number", "description":"The total amount of pending actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "pendingProjectActualsProject":{ "type":"number", "description":"The total amount of pending actuals for a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedProjectActualsWorkspace1":{ "type":"number", "description":"The total amount of confirmed actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "approvedProjectActualsWorkspace2":{ "type":"number", "description":"The total amount of confirmed actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "approvedProjectActualsWorkspace3":{ "type":"number", "description":"The total amount of confirmed actuals for a workspace.", "format":"double", "exampleSetFlag":false }, "approvedProjectActualsProject":{ "type":"number", "description":"The total amount of confirmed actuals for a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualRiskResponseProject":{ "type":"number", "description":"The actual cost of implementing a response action. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualRiskResponseWorkspace1":{ "type":"number", "description":"The actual cost of implementing a response action.", "format":"double", "exampleSetFlag":false }, "actualRiskResponseWorkspace2":{ "type":"number", "description":"The actual cost of implementing a response action.", "format":"double", "exampleSetFlag":false }, "actualRiskResponseWorkspace3":{ "type":"number", "description":"The actual cost of implementing a response action.", "format":"double", "exampleSetFlag":false }, "closedPostExposureProject":{ "type":"number", "description":"The mean post-response probability of a closed risk multiplied by the mean post-response probability of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "closedPostExposureWorkspace1":{ "type":"number", "description":"The mean post-response probability of a closed risk multiplied by the mean post-response probability of the risk.", "format":"double", "exampleSetFlag":false }, "closedPostExposureWorkspace2":{ "type":"number", "description":"The mean post-response probability of a closed risk multiplied by the mean post-response probability of the risk.", "format":"double", "exampleSetFlag":false }, "closedPostExposureWorkspace3":{ "type":"number", "description":"The mean post-response probability of a closed risk multiplied by the mean post-response probability of the risk.", "format":"double", "exampleSetFlag":false }, "closedPreExposureWorkspace1":{ "type":"number", "description":"The mean pre-response probability of a closed risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "closedPreExposureWorkspace2":{ "type":"number", "description":"The mean pre-response probability of a closed risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "closedPreExposureWorkspace3":{ "type":"number", "description":"The mean pre-response probability of a closed risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "closedPreExposureProject":{ "type":"number", "description":"The mean pre-response probability of a closed risk multiplied by the mean pre-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "openPostExposureWorkspace1":{ "type":"number", "description":"The mean post-response probability of an open risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPostExposureWorkspace2":{ "type":"number", "description":"The mean post-response probability of an open risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPostExposureWorkspace3":{ "type":"number", "description":"The mean post-response probability of an open risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPreExposureWorkspace1":{ "type":"number", "description":"The mean pre-response probability of an open risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPreExposureWorkspace2":{ "type":"number", "description":"The mean pre-response probability of an open risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "openPreExposureWorkspace3":{ "type":"number", "description":"The mean pre-response probability of an open risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponseProject":{ "type":"number", "description":"The estimated cost of implementing a response action. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponseWorkspace1":{ "type":"number", "description":"The planned value required to respond to a risk, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponseWorkspace2":{ "type":"number", "description":"The planned value required to respond to a risk, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponseWorkspace3":{ "type":"number", "description":"The planned value required to respond to a risk, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetWorkspace3":{ "type":"number", "description":"The pending manual cost of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetProject":{ "type":"number", "description":"The pending manual cost of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetWorkspace1":{ "type":"number", "description":"Calculated as the sum of all costs approved for the manual budget.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetWorkspace2":{ "type":"number", "description":"Calculated as the sum of all costs approved for the manual budget.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetWorkspace3":{ "type":"number", "description":"Calculated as the sum of all costs approved for the manual budget.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetProject":{ "type":"number", "description":"Calculated as the sum of all costs approved for the manual budget. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChanges":{ "type":"number", "description":"Calculated as the sum of all pending manual budget changes for the project. This field is in base currency and is calculated pendingManualBudgetChangesProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChangesWorkspace1":{ "type":"number", "description":"The pending manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChangesWorkspace2":{ "type":"number", "description":"The pending manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChangesWorkspace3":{ "type":"number", "description":"The pending manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetChangesProject":{ "type":"number", "description":"The pending manual budget changes of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChanges":{ "type":"number", "description":"Calculated as the sum of all approved manual budget changes in the change records for the project budget. This field is in base currency and is calculated from approvedManualBudgetChangesProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChangesWorkspace1":{ "type":"number", "description":"The approved manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChangesWorkspace2":{ "type":"number", "description":"The approved manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChangesWorkspace3":{ "type":"number", "description":"The approved manual budget changes of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetChangesProject":{ "type":"number", "description":"The approved manual budget changes of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfers":{ "type":"number", "description":"Calculated as the sum of all pending manual budget transfers for the project. This field is in base currency and is calculated from pendingManualBudgetTransfersProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfersWorkspace1":{ "type":"number", "description":"The pending manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfersWorkspace2":{ "type":"number", "description":"The pending manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfersWorkspace3":{ "type":"number", "description":"The pending manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetTransfersProject":{ "type":"number", "description":"The pending manual budget transfers of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfers":{ "type":"number", "description":"Calculated as the sum of all approved manual budget transfers for the project. This field is in base currency and is calculated from approvedManualBudgetTransfersProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfersWorkspace1":{ "type":"number", "description":"The approved manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfersWorkspace2":{ "type":"number", "description":"The approved manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfersWorkspace3":{ "type":"number", "description":"The approved manual budget transfers of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualBudgetTransfersProject":{ "type":"number", "description":"The approved manual budget transfers of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudget":{ "type":"number", "description":"The total approved current manual budget of a project. Calculated as the sum of Approved Original Manual Budget plus Approved Manual Budget Changes plus Approved Manual Budget Transfers. This field is in base currency and is calculated from approvedManualCurrentBudgetProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudgetWorkspace1":{ "type":"number", "description":"The approved current manual budget of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudgetWorkspace2":{ "type":"number", "description":"The approved current manual budget of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudgetWorkspace3":{ "type":"number", "description":"The approved current manual budget of a workspace.", "format":"double", "exampleSetFlag":false }, "approvedManualCurrentBudgetProject":{ "type":"number", "description":"The approved current manual budget of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetWorkspace1":{ "type":"number", "description":"The pending manual budget of a workspace.", "format":"double", "exampleSetFlag":false }, "pendingManualBudgetWorkspace2":{ "type":"number", "description":"The pending manual budget of a workspace.", "format":"double", "exampleSetFlag":false }, "projectActualCostProject":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                                                                  The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                                                  Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "projectEarnedCostProject":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                                                                  The cost value used for the Earned Value Management of a project.
                                                                                                                  Earned Value Management allows project managers to quantify project progress and objectively measure a project's success. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace1":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace2":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostWorkspace3":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace1":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace2":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostWorkspace3":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace1":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace2":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateWorkspace3":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace1":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                                                                  Calculated as Revised Cost plus Adjusted Cost. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace2":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                                                                  Calculated as Revised Cost plus Adjusted Cost. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostWorkspace3":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                                                                  Calculated as Revised Cost plus Adjusted Cost. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace1":{ "type":"number", "description":"The total amount of confirmed actuals, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace2":{ "type":"number", "description":"The total amount of confirmed actuals, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCostWorkspace3":{ "type":"number", "description":"The total amount of confirmed actuals, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostProject":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostProject":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingProjectActuals":{ "type":"number", "description":"The total of all actuals values with a status of Pending. This field is in base currency and is calculated from pendingProjectActualsProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedProjectActuals":{ "type":"number", "description":"Actuals that have been confirmed. This field is in base currency and is calculated from approvedProjectActualsProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualRiskResponse":{ "type":"number", "description":"The actual cost of responding to a risk. This field is in base currency and is calculated from actualRiskResponseProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "closedPostExposure":{ "type":"number", "description":"The mean post-response probability multiplied by the mean post response cost impact. The status of these risks is closed. This field is in base currency and is calculated from closedPostExposureProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "closedPreExposure":{ "type":"number", "description":"The mean pre-response probability multiplied by the pre-response mean cost impact. The status of these risks is closed. This field is in base currency and is calculated from closedPreExposureProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "openPostExposure":{ "type":"number", "description":"The mean post-response probability multiplied by the mean post response cost impact. The status of these risks is open. This field is in base currency and is calculated from openPostExposureProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "openPostExposureProject":{ "type":"number", "description":"The mean post-response probability of an open risk multiplied by the mean post-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "openPreExposure":{ "type":"number", "description":"The mean pre-response probability multiplied by the pre-response mean cost impact. The status of these risks is open. This field is in base currency and is calculated from openPreExposureProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "openPreExposureProject":{ "type":"number", "description":"The mean pre-response probability of an open risk multiplied by the mean pre-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedRiskResponse":{ "type":"number", "description":"The planned value required to respond to a risk. This field is in base currency and is calculated from plannedRiskResponseProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace2":{ "type":"number", "description":"The estimate of the cost needed to complete the work, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace3":{ "type":"number", "description":"The estimate of the cost needed to complete the work, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace1":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace2":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "eacCostWorkspace3":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. Calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace1":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace2":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "earnedCostWorkspace3":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace1":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace2":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "bacCostWorkspace3":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace1":{ "type":"number", "description":"The amount left to be spent, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace2":{ "type":"number", "description":"The amount left to be spent, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "remainingCostWorkspace3":{ "type":"number", "description":"The amount left to be spent, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace1":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace2":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "installedCostWorkspace3":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace1":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace2":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostWorkspace3":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostProject":{ "type":"number", "description":"The original cost of the scope assignment.
                                                                                                                  If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
                                                                                                                  If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "revisedCostProject":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "eacCostProject":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "etcCostProject":{ "type":"number", "description":"The estimate of the cost needed to complete the work.
                                                                                                                  Calculated as BAC Cost minus Earned Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "earnedCostProject":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "baselineCostProject":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateProject":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "bacCostProject":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                                                                  Calculated as Revised Cost plus Adjusted Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingCostProject":{ "type":"number", "description":"The amount left to be spent.
                                                                                                                  If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                                                                  If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "installedCostProject":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                                                                  If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                                                                  If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostProject":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedManualBudget":{ "type":"number", "description":"Calculated as the sum of all costs approved for the original manual budget. This field is in base currency and is calculated from approvedManualBudgetProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingManualBudget":{ "type":"number", "description":"Calculated as the sum of all costs pending for the original manual budget. This field is in base currency and is calculated from pendingManualBudgetProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "projectCPIProject":{ "type":"number", "description":"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. This value is based on the project currency.", "exampleSetFlag":false, "types":[ "number" ] }, "currentBudgetProject":{ "type":"number", "description":"The total cost of the project budget, including all transfers and changes. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedCost":{ "type":"number", "description":"The original cost of the scope assignment.
                                                                                                                  If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
                                                                                                                  If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingChangedCost":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. This field is in base currency and is calculated from pendingChangedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedChangedCost":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment. This field is in base currency and is calculated from approvedChangedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "revisedCost":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This field is in base currency and is calculated from revisedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "baselineCost":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedCost":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. This field is in base currency and is calculated from earnedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostToDate":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This field is in base currency and is calculated from actualCostToDateProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The amount left to be spent.
                                                                                                                  If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                                                                  If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "installedCost":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                                                                  If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                                                                  If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "adjustedCost":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. This field is in base currency and is calculated from adjustedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                                                                  Calculated as Revised Cost plus Adjusted Cost. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentBudget":{ "type":"number", "description":"The total cost of the project budget, including all transfers and changes. This field is in base currency and is calculated from currentBudgetProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace1":{ "type":"number", "description":"The total approved manual budget of a set of projects, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace2":{ "type":"number", "description":"The total approved manual budget of a set of projects, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "currentBudgetWorkspace3":{ "type":"number", "description":"The total approved manual budget of a set of projects, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "projectActualCost":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                                                                  The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                                                  Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This field is in base currency and is calculated from projectActualCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "projectEarnedCost":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                                                                  The cost value used for the Earned Value Management of a project.
                                                                                                                  Earned Value Management allows project managers to quantify project progress and objectively measure a project's success. This field is in base currency and is calculated from projectEarnedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "projectCPI":{ "type":"number", "description":"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. This field is in base currency and is calculated from projectCPIProject field based on the specified exchange rate.", "exampleSetFlag":false, "types":[ "number" ] }, "plannedCostWorkspace1":{ "type":"number", "description":"The original cost of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostWorkspace2":{ "type":"number", "description":"The original cost of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "plannedCostWorkspace3":{ "type":"number", "description":"The original cost of the scope assignment, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace1":{ "type":"number", "description":"The Original Cost before the baseline is set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace2":{ "type":"number", "description":"The Original Cost before the baseline is set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "revisedCostWorkspace3":{ "type":"number", "description":"The Original Cost before the baseline is set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace1":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace2":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "baselineCostWorkspace3":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCostWorkspace1":{ "type":"number", "description":"The estimate of the cost needed to complete the work, calculated based on the workspace currency.", "format":"double", "exampleSetFlag":false }, "etcCost":{ "type":"number", "description":"The estimate of the cost needed to complete the work.
                                                                                                                  Calculated as BAC Cost minus Earned Cost. This field is in base currency and is calculated from etcCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "eacCost":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. This field is in base currency and is calculated from eacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "bacCost":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. This field is in base currency and is calculated from bacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "rowId":{ "type":"integer", "description":"The unique identifier of a cost sheet row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCurrency":{ "title":"ApiEntityCurrency", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "currencyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the currency.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The unique identifier for the currency. The currency code is 3 characters.", "exampleSetFlag":false, "types":[ "string" ] }, "currencySymbol":{ "maxLength":6, "minLength":1, "type":"string", "description":"The symbol for the currency.", "exampleSetFlag":false, "types":[ "string" ] }, "systemCurrencyFlag":{ "type":"boolean", "description":"The base currency is the default currency when new workspaces are created.
                                                                                                                  Any currency conversions will be measured against this form of currency.", "exampleSetFlag":false, "types":[ "boolean" ] }, "decimalsToDisplay":{ "multipleOf":"0.000010", "maximum":5, "minimum":0, "type":"integer", "description":"The number of decimals to display.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "currencyId":{ "type":"integer", "description":"The unique identifier of a currency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the workspace currency.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the currency and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCurrencyInput":{ "title":"ApiEntityCurrencyInput", "required":[ "currencyCode", "currencyName", "currencySymbol", "decimalsToDisplay", "workspaceId" ], "type":"object", "properties":{ "currencyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the currency.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The unique identifier for the currency. The currency code is 3 characters.", "exampleSetFlag":false, "types":[ "string" ] }, "currencySymbol":{ "maxLength":6, "minLength":1, "type":"string", "description":"The symbol for the currency.", "exampleSetFlag":false, "types":[ "string" ] }, "systemCurrencyFlag":{ "type":"boolean", "description":"The base currency is the default currency when new workspaces are created.
                                                                                                                  Any currency conversions will be measured against this form of currency.", "exampleSetFlag":false, "types":[ "boolean" ] }, "decimalsToDisplay":{ "multipleOf":"0.000010", "maximum":5, "minimum":0, "type":"integer", "description":"The number of decimals to display.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "currencyId":{ "type":"integer", "description":"The unique identifier of a currency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the workspace currency.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] } }, "description":"This entity represents a Currency object, a unique Currency object can be identified by the following combinations of the fields.
                                                                                                                  • currencyId
                                                                                                                  • currencyCode,workspaceId
                                                                                                                  • currencyCode,workspaceCode
                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityCurrencySeed":{ "title":"ApiEntityCurrencySeed", "type":"object", "properties":{ "currencyName":{ "maxLength":255, "type":"string", "description":"The name of the currency.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyCode":{ "maxLength":3, "type":"string", "description":"The unique identifier for the currency. The currency code is 3 characters.", "exampleSetFlag":false, "types":[ "string" ] }, "currencySymbol":{ "maxLength":20, "type":"string", "description":"The symbol for the currency.", "exampleSetFlag":false, "types":[ "string" ] }, "currencySeedId":{ "type":"integer", "description":"The unique identifier of a seeded currency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "decimalsToDisplay":{ "type":"integer", "description":"The number of decimals to display.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestBaselineCategoryIdentifier":{ "title":"ApiEntityAssignUnassignRequestBaselineCategoryIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/BaselineCategoryIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestCodeTypeIdentifier":{ "title":"ApiEntityAssignUnassignRequestCodeTypeIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/CodeTypeIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestCostCategoryIdentifier":{ "title":"ApiEntityAssignUnassignRequestCostCategoryIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/CostCategoryIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestCurrencyIdentifier":{ "title":"ApiEntityAssignUnassignRequestCurrencyIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/CurrencyIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestCurveIdentifier":{ "title":"ApiEntityAssignUnassignRequestCurveIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/CurveIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestLocationIdentifier":{ "title":"ApiEntityAssignUnassignRequestLocationIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/LocationIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestMeasureIdentifier":{ "title":"ApiEntityAssignUnassignRequestMeasureIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/MeasureIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestReasonIdentifier":{ "title":"ApiEntityAssignUnassignRequestReasonIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ReasonIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestReportCycleIdentifier":{ "title":"ApiEntityAssignUnassignRequestReportCycleIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ReportCycleIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestRiskMatrixIdentifier":{ "title":"ApiEntityAssignUnassignRequestRiskMatrixIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/RiskMatrixIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier":{ "title":"ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/RiskScoreTypeIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestRuleOfCreditIdentifier":{ "title":"ApiEntityAssignUnassignRequestRuleOfCreditIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/RuleOfCreditIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestStrategyTypeIdentifier":{ "title":"ApiEntityAssignUnassignRequestStrategyTypeIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/StrategyTypeIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier":{ "title":"ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"This field represents the assign or unassign action of the object to the workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/UnitsOfMeasureIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityCalendarAssignUnassignRequest":{ "title":"ApiEntityCalendarAssignUnassignRequest", "type":"object", "properties":{ "workspaces":{ "type":"array", "description":"The list of workspaces the object is inherited to.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendarWorkspaceAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "objectIdentifier":{ "description":"This is a generic field that represents the fields that uniquely identify an object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/CalendarIdentifier" } ] } }, "exampleSetFlag":false }, "ApiEntityCalendarWorkspaceAssignUnassignRequest":{ "title":"ApiEntityCalendarWorkspaceAssignUnassignRequest", "required":[ "workspaceCode" ], "type":"object", "properties":{ "isAssignableToProject":{ "type":"boolean", "description":"Indicates whether or not the calendar can be assigned to a project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isAssignableToResource":{ "type":"boolean", "description":"Indicates whether or not the calendar can be assigned to a resource.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"This field represents the assign or unassign action in the request.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ASSIGN", "UNASSIGN", "UPDATE" ] } }, "exampleSetFlag":false }, "ApiEntityCombinedAssignUnassignRequest":{ "title":"ApiEntityCombinedAssignUnassignRequest", "type":"object", "properties":{ "riskScoreTypes":{ "type":"array", "description":"The list of workspace risk score type assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "riskMatrices":{ "type":"array", "description":"The list of risk matrix category assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestRiskMatrixIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "calendars":{ "type":"array", "description":"The list of workspace calendar assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCalendarAssignUnassignRequest", "exampleSetFlag":false }, "types":[ "array" ] }, "currencies":{ "type":"array", "description":"The list of currency assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCurrencyIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "locations":{ "type":"array", "description":"The list of location assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestLocationIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "unitsOfMeasures":{ "type":"array", "description":"The list of unit of measure assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "codeTypes":{ "type":"array", "description":"The list of code type assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCodeTypeIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "costCategories":{ "type":"array", "description":"The list of cost category assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCostCategoryIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "reportCycles":{ "type":"array", "description":"The list of report cycle assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestReportCycleIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "measures":{ "type":"array", "description":"The list of measure assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestMeasureIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "baselineCategories":{ "type":"array", "description":"The list of baseline category assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestBaselineCategoryIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "ruleOfCredits":{ "type":"array", "description":"The list of rule of credit assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestRuleOfCreditIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "strategyTypes":{ "type":"array", "description":"The list of strategy type assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestStrategyTypeIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "reasons":{ "type":"array", "description":"The list of reason assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestReasonIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "curves":{ "type":"array", "description":"The list of curve assign, promote, and unassign requests to workspaces. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCurveIdentifier", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceAssignUnassignRequest":{ "title":"ApiEntityWorkspaceAssignUnassignRequest", "required":[ "workspaceCode" ], "type":"object", "properties":{ "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"This field represents the assign or unassign action in the request.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ASSIGN", "UNASSIGN", "UPDATE" ] } }, "exampleSetFlag":false }, "BaselineCategoryIdentifier":{ "title":"BaselineCategoryIdentifier", "type":"object", "properties":{ "baselineCategoryId":{ "type":"integer", "description":"The system-generated unique identifier of a baseline category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineCategoryName":{ "maxLength":255, "type":"string", "description":"The name of the baseline category.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "CurrencyIdentifier":{ "title":"CurrencyIdentifier", "type":"object", "properties":{ "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The unique identifier for the currency. The currency code is 3 characters.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyId":{ "type":"integer", "description":"The unique identifier of a currency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityActivityDiscussion":{ "title":"ApiEntityActivityDiscussion", "required":[ "applicationUserId", "comment" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "commentDecoded":{ "type":"string", "description":"The decoded comment text where user references are replaced with the corresponding email Ids.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The initial post that begins a discussion thread.
                                                                                                                    Discussions can take place on your projects, portfolios, and other object pages throughout the application.", "exampleSetFlag":false, "types":[ "string" ] }, "discussionDate":{ "type":"string", "description":"The created date of the discussion.", "format":"date-time", "exampleSetFlag":false }, "applicationUserName":{ "maxLength":255, "type":"string", "description":"The user name of the user who submitted the discussion comment.", "exampleSetFlag":false, "types":[ "string" ] }, "discussionId":{ "type":"integer", "description":"The system-generated identifier of a field for the discussion.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentDiscussionId":{ "type":"integer", "description":"The unique identifier of a parent discussion.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "applicationUserId":{ "type":"integer", "description":"The user name of the user who submitted the discussion comment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityTaskDiscussion":{ "title":"ApiEntityTaskDiscussion", "required":[ "applicationUserId", "comment" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "commentDecoded":{ "type":"string", "description":"The decoded comment text where user references are replaced with the corresponding email Ids.", "exampleSetFlag":false, "types":[ "string" ] }, "taskId":{ "type":"integer", "description":"The unique identifier of a task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The initial post that begins a discussion thread.
                                                                                                                    Discussions can take place on your projects, portfolios, and other object pages throughout the application.", "exampleSetFlag":false, "types":[ "string" ] }, "discussionDate":{ "type":"string", "description":"The created date of the discussion.", "format":"date-time", "exampleSetFlag":false }, "applicationUserName":{ "maxLength":255, "type":"string", "description":"The user name of the user who submitted the discussion comment.", "exampleSetFlag":false, "types":[ "string" ] }, "discussionId":{ "type":"integer", "description":"The system-generated identifier of a field for the discussion.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentDiscussionId":{ "type":"integer", "description":"The unique identifier of a parent discussion.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "applicationUserId":{ "type":"integer", "description":"The user name of the user who submitted the discussion comment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityDocumentUserPermissionsResponse":{ "title":"ApiEntityDocumentUserPermissionsResponse", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"Profiles response with individual message and statusCodes.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfileResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "documentId":{ "type":"integer", "description":"The system-generated identifier of the file, folder, or template.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityDocumentProfileInput":{ "title":"ApiEntityDocumentProfileInput", "type":"object", "properties":{ "documentProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the document profile.", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityDocumentUserPermissions":{ "title":"ApiEntityDocumentUserPermissions", "type":"object", "properties":{ "path":{ "type":"string", "description":"The path of the file or folder from it's root folder.
                                                                                                                    The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeId":{ "type":"integer", "description":"The system-generated identifier of the object of the context the file or folder is created in.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocumentProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "documentId":{ "type":"integer", "description":"The system-generated identifier of the file, folder, or template.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "type":"string", "description":"The object name of the context the file or folder is created in.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "genericPortfolio", "project", "template", "idea", "program", "strategy" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueDocument":{ "title":"ApiEntityCodeValueDocument", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueDocumentId":{ "type":"integer", "description":"The system-generated identifier of a code value document assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateUser":{ "maxLength":255, "type":"string", "description":"This field represent the user name of the user who last modified the record.", "exampleSetFlag":false, "types":[ "string" ] }, "createDate":{ "type":"string", "description":"This field represent the date the record is created.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "createUser":{ "maxLength":255, "type":"string", "description":"This field represent the user name of the user who created the record.", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityDocument":{ "title":"ApiEntityDocument", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"Indicates whether this is a file or a folder.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FOLDER", "DOCUMENT", "XLSX", "DOCX", "DOC", "XLS" ] }, "name":{ "maxLength":255, "type":"string", "description":"The name of the file, folder, or template.", "exampleSetFlag":false, "types":[ "string" ] }, "id":{ "maxLength":18, "type":"string", "description":"The system-generated identifier of the file, folder, or template.", "exampleSetFlag":false, "types":[ "string" ] }, "size":{ "type":"integer", "description":"The current size of the file in bytes.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeId":{ "type":"integer", "description":"The system-generated identifier of the object of the context the file or folder is created in.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "comment":{ "maxLength":4000, "type":"string", "description":"Additional notes about the file.", "exampleSetFlag":false, "types":[ "string" ] }, "version":{ "maxLength":255, "type":"string", "description":"The current version of the file.", "exampleSetFlag":false, "types":[ "string" ] }, "documentConfiguredFields":{ "uniqueItems":true, "type":"array", "description":"The list of configured fields for a file. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocumentConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "parentType":{ "maxLength":60, "type":"string", "description":"The context in which the file is added.", "exampleSetFlag":false, "types":[ "string" ] }, "isActualRoot":{ "type":"boolean", "description":"Indicates whether or not this folder is the root node in a folder structure.", "exampleSetFlag":false, "types":[ "boolean" ] }, "annotationCount":{ "type":"object", "description":"The total number of annotations created for the file.", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_DB_DOCUMENT_KEY:document_annotation_count_description" } }, "hasChildren":{ "type":"boolean", "description":"Indicates whether or not the folder has children.", "exampleSetFlag":false, "types":[ "boolean" ] }, "mimeType":{ "maxLength":80, "type":"string", "description":"The type of a file.", "exampleSetFlag":false, "types":[ "string" ] }, "checkedOutBy":{ "maxLength":255, "type":"string", "description":"The user that checked out a file.", "exampleSetFlag":false, "types":[ "string" ] }, "checkedOutUserId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "checkedOutDate":{ "type":"string", "description":"The date the user checked out the file.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "checkedOut":{ "type":"boolean", "description":"Indicates whether or not the file is checked-out.", "exampleSetFlag":false, "types":[ "boolean" ] }, "codeValuesDocument":{ "type":"array", "description":"The list of code values for a file. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueDocument", "exampleSetFlag":false }, "types":[ "array" ] }, "parentFolderPath":{ "type":"string", "description":"The path of the parent folder from it's root folder.
                                                                                                                    The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "scanStatus":{ "type":"string", "description":"Virus scan status of the current version of a file. A virus scan could return one of the following virus statuses:
                                                                                                                    • SCAN_FAILED : A virus was found for this file.
                                                                                                                    • SCAN_CLEARED : Virus scan was run and found the file to not contain viruses.
                                                                                                                    • SCAN_DISABLED : File has not been scanned for viruses because scanning at has been disabled for the data center.
                                                                                                                    • SCAN_INCONCLUSIVE :Virus scan was run but was not able to provide a cleared status. Try to scan the file again, or contact Oracle support.
                                                                                                                    • SCAN_PENDING : Virus scan is in progress for this file.
                                                                                                                    • SCAN_ERROR : There was an error while scanning the file for viruses. Try to scan the file again.
                                                                                                                    ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SCAN_PENDING", "SCAN_CLEARED", "SCAN_FAILED", "SCAN_INCONCLUSIVE", "SCAN_ERROR", "SCAN_DISABLED" ] }, "description":{ "maxLength":4000, "type":"string", "description":"Additional information about the file.", "exampleSetFlag":false, "types":[ "string" ] }, "parentId":{ "maxLength":18, "type":"string", "description":"The system-generated identifier of the parent object of the file or folder.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-specified identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "locationName":{ "maxLength":255, "type":"string", "description":"The name of the location associated with the file.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "type":"number", "description":"The longitude of the location associated with the file.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "type":"number", "description":"The latitude of the location associated with the file.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "type":"string", "description":"The first line of the address of a location.
                                                                                                                    This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "type":"string", "description":"The second line of the address associated with a file.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "type":"string", "description":"The postal code of the location associated with the file.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "type":"string", "description":"The name of the city associated with a file.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "type":"string", "description":"The name of the state of the location associated with the file.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "type":"string", "description":"The code of the state of the location associated with the file.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "type":"string", "description":"The code of the country associated with a file.", "exampleSetFlag":false, "types":[ "string" ] }, "updateUser":{ "maxLength":255, "type":"string", "description":"This field represent the user name of the user who last modified the record.", "exampleSetFlag":false, "types":[ "string" ] }, "createDate":{ "type":"string", "description":"This field represent the date the record is created.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "createUser":{ "maxLength":255, "type":"string", "description":"This field represent the user name of the user who created the record.", "exampleSetFlag":false, "types":[ "string" ] }, "url":{ "type":"string", "description":"The WebDAV URL for the file or folder.
                                                                                                                    It allows you to configure file management extensions to map an object to your machine.
                                                                                                                    Maximum Length: 2,147,483,647", "exampleSetFlag":false, "types":[ "string" ] }, "scope":{ "type":"string", "description":"The object name of the context the file or folder is created in.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "genericPortfolio", "project", "template", "idea", "program", "strategy" ] }, "author":{ "maxLength":255, "type":"string", "description":"The system-generated identifier of a user assigned as an owner of this object.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityDocumentConfiguredFieldValue":{ "title":"ApiEntityDocumentConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "documentConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the File Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "documentId":{ "type":"integer", "description":"The system-generated identifier of the file, folder, or template.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":255, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "updateUser":{ "maxLength":255, "type":"string", "description":"This field represent the user name of the user who last modified the record.", "exampleSetFlag":false, "types":[ "string" ] }, "createDate":{ "type":"string", "description":"This field represent the date the record is created.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "createUser":{ "maxLength":255, "type":"string", "description":"This field represent the user name of the user who created the record.", "exampleSetFlag":false, "types":[ "string" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueDocumentInput":{ "title":"ApiEntityCodeValueDocumentInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueDocumentId":{ "type":"integer", "description":"The system-generated identifier of a code value document assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueDocument object, a unique CodeValueDocument object can be identified by the following combinations of the fields.
                                                                                                                    • codeValueDocumentId
                                                                                                                    • codeValueId
                                                                                                                    • codeValueCode,codeTypeId
                                                                                                                    • codeValueCode,codeTypeCode
                                                                                                                    • codeTypeCode,codeValueCode,parentId
                                                                                                                    • codeValueCode,codeTypeId,parentId
                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityDocumentConfiguredFieldValueInput":{ "title":"ApiEntityDocumentConfiguredFieldValueInput", "type":"object", "properties":{ "documentConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the File Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "documentId":{ "type":"integer", "description":"The system-generated identifier of the file, folder, or template.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":255, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a DocumentConfiguredFieldValue object, a unique DocumentConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                      • documentConfiguredFieldValueId
                                                                                                                      • columnDefinitionId
                                                                                                                      • columnName
                                                                                                                      • columnLabel
                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityDocumentInput":{ "title":"ApiEntityDocumentInput", "required":[ "name", "parentId" ], "type":"object", "properties":{ "name":{ "maxLength":255, "type":"string", "description":"The name of the file, folder, or template.", "exampleSetFlag":false, "types":[ "string" ] }, "id":{ "maxLength":18, "type":"string", "description":"The system-generated identifier of the file, folder, or template.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeId":{ "type":"integer", "description":"The system-generated identifier of the object of the context the file or folder is created in.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "comment":{ "maxLength":4000, "type":"string", "description":"Additional notes about the file.", "exampleSetFlag":false, "types":[ "string" ] }, "documentConfiguredFields":{ "uniqueItems":true, "type":"array", "description":"The list of configured fields for a file. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityDocumentConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "codeValuesDocument":{ "type":"array", "description":"The list of code values for a file. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueDocumentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "parentFolderPath":{ "type":"string", "description":"The path of the parent folder from it's root folder.
                                                                                                                        The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"Additional information about the file.", "exampleSetFlag":false, "types":[ "string" ] }, "parentId":{ "maxLength":18, "type":"string", "description":"The system-generated identifier of the parent object of the file or folder.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-specified identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "locationName":{ "maxLength":255, "type":"string", "description":"The name of the location associated with the file.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "type":"number", "description":"The longitude of the location associated with the file.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "type":"number", "description":"The latitude of the location associated with the file.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "type":"string", "description":"The first line of the address of a location.
                                                                                                                        This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "type":"string", "description":"The second line of the address associated with a file.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "type":"string", "description":"The postal code of the location associated with the file.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "type":"string", "description":"The name of the city associated with a file.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "type":"string", "description":"The name of the state of the location associated with the file.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":20, "type":"string", "description":"The code of the state of the location associated with the file.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "type":"string", "description":"The code of the country associated with a file.", "exampleSetFlag":false, "types":[ "string" ] }, "scope":{ "type":"string", "description":"The object name of the context the file or folder is created in.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "genericPortfolio", "project", "template", "idea", "program", "strategy" ] } }, "description":"This entity represents a Document object, a unique Document object can be identified by the following combinations of the fields.
                                                                                                                        • id
                                                                                                                        • parentId,name
                                                                                                                        • parentFolderPath,name,scope,workspaceId
                                                                                                                        • parentFolderPath,name,scope,workspaceCode
                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityZipRequestDetails":{ "title":"ApiEntityZipRequestDetails", "type":"object", "properties":{ "zipRequestId":{ "type":"integer", "description":"The system-generated identifier of a zip request created.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "zipRequestStatus":{ "type":"string", "description":"The status of the file zip request process.
                                                                                                                          • IN_QUEUE: The zip requests is waiting to be processed.
                                                                                                                          • ZIP_CREATION_IN_PROGRESS: The creation of the zip folder is in progress.
                                                                                                                          • ZIP_CREATION_IN_PROGRESS_WITH_WARNING : The creation of the zip folder is in process, but some files could not be included.
                                                                                                                          • READY_FOR_DOWNLOAD: The creation of the zip folder has completed and is ready for download.
                                                                                                                          • REQUEST_FAILED: An error occured during the zip folder creation and couldn't complete the request
                                                                                                                          • REQUEST_FAILED_NO_FILES: The zip folder could not be created. There are no files to add to the .zip folder
                                                                                                                          • REQUEST_EXPIRED: The zip folder was created but is deleted after 24 hours.
                                                                                                                          ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IN_QUEUE", "ZIP_CREATION_IN_PROGRESS", "ZIP_CREATION_IN_PROGRESS_WITH_WARNING", "READY_FOR_DOWNLOAD", "REQUEST_FAILED", "REQUEST_FAILED_NO_FILES", "REQUEST_EXPIRED" ] }, "expiresAt":{ "type":"string", "description":"The date and time the file will be available for downloading. Once this time has passed, the file is no longer available and will need to be downloaded again.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "errorDetails":{ "description":"The field represents the error details in case of zip request in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityZipRequestErrorDetails" } ] } }, "exampleSetFlag":false }, "ApiEntityZipRequestErrorDetails":{ "title":"ApiEntityZipRequestErrorDetails", "type":"object", "properties":{ "cause":{ "maxLength":4000, "type":"string", "description":"The cause for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.", "exampleSetFlag":false, "types":[ "string" ] }, "message":{ "type":"string", "description":"This field represents the error message when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "resolution":{ "type":"string", "description":"The resolution for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityZipRequest":{ "title":"ApiEntityZipRequest", "type":"object", "properties":{ "scopeId":{ "type":"integer", "description":"The system-generated identifier of the object of the context the file is created in.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "documents":{ "type":"array", "description":"The list of files and folders.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/DocumentIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "includeUnscannedFiles":{ "type":"boolean", "description":"This parameter is used to determine whether to include the files that are un-scanned or not.", "exampleSetFlag":false, "types":[ "boolean" ] }, "scopeCode":{ "maxLength":255, "type":"string", "description":"The user-specified identifier of the object of the context the file is created in.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "type":"string", "description":"The object name of the context the file is created in.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "genericPortfolio", "project", "idea", "program" ] } }, "description":"This entity represents a ZipRequest object, a unique ZipRequest object can be identified by the following combinations of the fields.
                                                                                                                          • scope,scopeId
                                                                                                                          • scope,scopeCode,workspaceId
                                                                                                                          • scope,scopeCode,workspaceCode
                                                                                                                            • ", "exampleSetFlag":false }, "DocumentIdentifier":{ "title":"DocumentIdentifier", "type":"object", "properties":{ "name":{ "type":"string", "description":"The name of the file, folder, or template.", "exampleSetFlag":false, "types":[ "string" ] }, "id":{ "type":"string", "description":"The system-generated identifier of the file, folder, or template.", "exampleSetFlag":false, "types":[ "string" ] }, "parentFolderPath":{ "type":"string", "description":"The path of the parent folder from it's root folder.
                                                                                                                            The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "parentId":{ "type":"string", "description":"The system-generated identifier of the parent object of the file or folder.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-specified identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "type":"string", "description":"The object name of the context the file or folder is created in.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "genericPortfolio", "project", "idea", "program" ] } }, "exampleSetFlag":false }, "ApiEntityAnnotation":{ "title":"ApiEntityAnnotation", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "type":"string", "description":"The name of an annotation.", "exampleSetFlag":false, "types":[ "string" ] }, "annotations":{ "type":"object", "description":"The annotations of a file.", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_RESOURCE_DOCUMENT_KEY:document_resource_annotations" } }, "version":{ "maxLength":255, "type":"string", "description":"The version label associated with the annotation.", "exampleSetFlag":false, "types":[ "string" ] }, "ucrObjectId":{ "maxLength":18, "type":"string", "description":"The system-generated identifier of an object whether the file is created.", "exampleSetFlag":false, "types":[ "string" ] }, "annotationDate":{ "type":"string", "description":"The date on which an annotation was added to a file.", "format":"date-time", "exampleSetFlag":false }, "annotationId":{ "type":"integer", "description":"The system-generated identifier of an annotation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "annotationString":{ "type":"string", "description":"Maximum Length: 2147483647
                                                                                                                            A file annotation.", "exampleSetFlag":false, "types":[ "string" ] }, "ownerId":{ "type":"integer", "description":"The system-generated identifier of the user that authored the annotation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pageNum":{ "type":"integer", "description":"The page number an annotation is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFileVersion":{ "title":"ApiEntityFileVersion", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "size":{ "type":"integer", "description":"The size of a file in bytes.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "version":{ "maxLength":255, "type":"string", "description":"The version of a file.", "exampleSetFlag":false, "types":[ "string" ] }, "comments":{ "maxLength":4000, "type":"string", "description":"A comment associated with a file version.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityReference":{ "title":"ApiEntityReference", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "type":"string", "description":"The name of the object the file is linked to.", "exampleSetFlag":false, "types":[ "string" ] }, "documentId":{ "maxLength":0, "type":"string", "description":"The system-generated identifier of a document.", "exampleSetFlag":false, "types":[ "string" ] }, "referenceId":{ "type":"integer", "description":"The system-generated identifier of an object reference.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "objectId":{ "type":"integer", "description":"The system-generated identifier of the object the file is linked to.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "code":{ "maxLength":60, "type":"string", "description":"The code of the object the file is linked to.", "exampleSetFlag":false, "types":[ "string" ] }, "scope":{ "type":"string", "description":"The object name the file is linked to.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "project", "pbs", "wbs", "activity", "workPackage", "scopeItem", "scopeItemAssignment", "workflowInstance", "formInstance", "contract", "commitment", "changeOrder", "potentialChangeOrder", "potentialChangeOrderProposal", "paymentApplication", "submittals", "rfi", "changeEvents", "fund", "portfolioFund", "customLogItem", "risk", "programRisk", "constraint", "customLogItemProgram", "programFund", "workManagerTask" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRescanResponse":{ "title":"ApiEntityRescanResponse", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "type":"string", "description":"The name of the file, folder, or template.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "message":{ "type":"string", "description":"The information populated based on result of the rescan operation. The field is non-persistable and thus maximum length is not applicable.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "id":{ "maxLength":18, "type":"string", "description":"The system-generated identifier of the file, folder, or template.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "version":{ "maxLength":255, "type":"string", "description":"The version of the file the rescan has been triggered.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the rescan API operation of a specific file.", "format":"int64", "readOnly":true, "exampleSetFlag":false, "types":[ "integer" ] }, "parentFolderPath":{ "maxLength":18, "type":"string", "description":"The path of the parent folder from it's root folder.
                                                                                                                            The field is non-persistable and thus maximum length is not applicable.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "scanStatus":{ "type":"string", "description":"Virus scan status of the version of a file the rescan has been triggered. A virus scan could return one of the following virus statuses:
                                                                                                                            • SCAN_FAILED : A virus was found for this file.
                                                                                                                            • SCAN_CLEARED : Virus scan was run and found the file to not contain viruses.
                                                                                                                            • SCAN_DISABLED : File has not been scanned for viruses because scanning at has been disabled for the data center.
                                                                                                                            • SCAN_INCONCLUSIVE :Virus scan was run but was not able to provide a cleared status. Try to scan the file again, or contact Oracle support.
                                                                                                                            • SCAN_PENDING : Virus scan is in progress for this file.
                                                                                                                            • SCAN_ERROR : There was an error while scanning the file for viruses. Try to scan the file again.
                                                                                                                            ", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SCAN_PENDING", "SCAN_CLEARED", "SCAN_FAILED", "SCAN_INCONCLUSIVE", "SCAN_ERROR", "SCAN_DISABLED" ] }, "parentId":{ "maxLength":18, "type":"string", "description":"The system-generated identifier of the parent object of the file or folder.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-specified identifier of a workspace.", "format":"int64", "readOnly":true, "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "type":"string", "description":"The object name of the context the file or folder is created in.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ], "enum":[ "genericPortfolio", "project", "template", "idea", "program", "strategy" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRescanRequest":{ "title":"ApiEntityRescanRequest", "required":[ "id" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "type":"string", "description":"The name of the file, folder, or template.", "exampleSetFlag":false, "types":[ "string" ] }, "id":{ "maxLength":18, "type":"string", "description":"The system-generated identifier of the file, folder, or template.", "exampleSetFlag":false, "types":[ "string" ] }, "version":{ "maxLength":255, "type":"string", "description":"The version of the file to be rescanned.", "exampleSetFlag":false, "types":[ "string" ] }, "parentFolderPath":{ "maxLength":18, "type":"string", "description":"The path of the parent folder from it's root folder.
                                                                                                                            The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "parentId":{ "maxLength":18, "type":"string", "description":"The system-generated identifier of the parent object of the file or folder.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-specified identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "type":"string", "description":"The object name of the context the file or folder is created in.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "genericPortfolio", "project", "template", "idea", "program", "strategy" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a RescanRequest object, a unique RescanRequest object can be identified by the following combinations of the fields.
                                                                                                                            • id
                                                                                                                            • parentId,name
                                                                                                                            • parentFolderPath,name,scope,workspaceId
                                                                                                                            • parentFolderPath,name,scope,workspaceCode
                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityDocumentFolderStructureTemplate":{ "title":"ApiEntityDocumentFolderStructureTemplate", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "documentFolderStructureTemplateId":{ "type":"integer", "description":"The system-generated identifier of a document folder structure template. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "templateName":{ "maxLength":255, "type":"string", "description":"The name of the document template.", "exampleSetFlag":false, "types":[ "string" ] }, "systemGenerated":{ "type":"boolean", "description":"Determines whether a template was created by a user or the system.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the document folder structure.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the document folder structure and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityDocumentFolderStructureTemplateInput":{ "title":"ApiEntityDocumentFolderStructureTemplateInput", "required":[ "templateName", "workspaceId" ], "type":"object", "properties":{ "documentFolderStructureTemplateId":{ "type":"integer", "description":"The system-generated identifier of a document folder structure template. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "templateName":{ "maxLength":255, "type":"string", "description":"The name of the document template.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a DocumentFolderStructureTemplate object, a unique DocumentFolderStructureTemplate object can be identified by the following combinations of the fields.
                                                                                                                              • documentFolderStructureTemplateId
                                                                                                                              • templateName,workspaceId
                                                                                                                              • templateName,workspaceCode
                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityEvaluationCategory":{ "title":"ApiEntityEvaluationCategory", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"Details describing the evaluation category.", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"The order in which the evaluation category is displayed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "subCategories":{ "type":"array", "description":"The evaluation sub-categories of an evaluation category.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityEvaluationSubCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "categoryId":{ "type":"integer", "description":"The unique identifier for an evaluation category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "categoryName":{ "maxLength":255, "type":"string", "description":"The name of the evaluation category.", "exampleSetFlag":false, "types":[ "string" ] }, "weightPercent":{ "type":"number", "description":"The weight or relative rank of the evaluation node compared to its siblings. This value indicates the percentage that the evaluation node is contributing to the parent strategy. The Weight Percent for all sibling evaluation nodes equals 100. This field is read-only.", "format":"double", "exampleSetFlag":false }, "evaluationMatrixId":{ "type":"integer", "description":"The unique identifier of the evaluation matrix to which the evaluation category is associated.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "weight":{ "maximum":100, "minimum":1, "type":"integer", "description":"The relative weight of the sibling evaluation node to indicate contribution of a given node to its parent evaluation node.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityEvaluationMatrix":{ "title":"ApiEntityEvaluationMatrix", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "lastEvaluationChange":{ "type":"string", "description":"The time stamp of the most recent change to a category, sub-category, or rank of the evaluation matrix. ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"Details describing the evaluation matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "categories":{ "type":"array", "description":"The evaluation categories of an evaluation matrix.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityEvaluationCategory", "exampleSetFlag":false }, "types":[ "array" ] }, "evaluationMatrixName":{ "maxLength":255, "type":"string", "description":"The name of the evaluation matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationMatrixId":{ "type":"integer", "description":"The unique identifier for the evaluation matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The workspace the evaluation matrix is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                                Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the evaluation matrix and the workspace. Possible values are Owned and Inherited.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "isActive":{ "type":"boolean", "description":"The status of Evaluation Matrix.
                                                                                                                                Active: The Evaluation Matrix is in an usable state.
                                                                                                                                Inactive: The Evaluation Matrix is not in an usable state.", "exampleSetFlag":false, "types":[ "boolean" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityEvaluationRank":{ "title":"ApiEntityEvaluationRank", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "level":{ "type":"integer", "description":"The identifier for the order in which the ranks are displayed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "color":{ "maxLength":20, "type":"string", "description":"The color representing the evaluation ranking.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"Details describing the evaluation ranking.", "exampleSetFlag":false, "types":[ "string" ] }, "rankName":{ "maxLength":255, "type":"string", "description":"The name of the evaluation ranking.", "exampleSetFlag":false, "types":[ "string" ] }, "subCategoryId":{ "type":"integer", "description":"The unique identifier of the evaluation sub-category to which the evaluation rank is associated.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "weightPercent":{ "type":"number", "description":"The weight percentage for the evaluation ranking. This value is automatically calculated based on the number of selected ranks.", "format":"double", "exampleSetFlag":false }, "rankId":{ "type":"integer", "description":"The unique identifier for an evaluation rank.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityEvaluationSubCategory":{ "title":"ApiEntityEvaluationSubCategory", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"Details describing the evaluation sub-category.", "exampleSetFlag":false, "types":[ "string" ] }, "subCategoryName":{ "maxLength":255, "type":"string", "description":"The name of the evaluation sub-category.", "exampleSetFlag":false, "types":[ "string" ] }, "rankLevels":{ "type":"integer", "description":"The number of options available on the rating scale for the sub-category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "owningWorkspaceId":{ "type":"integer", "description":"ID of the workspace for which sub-category has to be found.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "subCategoryId":{ "type":"integer", "description":"The unique identifier for an evaluation sub-category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The order in which the evaluation sub-category is displayed within a category.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "categoryId":{ "type":"integer", "description":"The unique identifier of the evaluation category to which the evaluation sub-category is associated.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "weightPercent":{ "type":"number", "description":"The weight or relative rank of the evaluation sub-category node compared to its siblings. This value indicates the percentage that the evaluation sub-category node is contributing to the parent category. The total Weight Percent for all sibling evaluation sub-category nodes equals 100.", "format":"double", "exampleSetFlag":false }, "enabledFlag":{ "type":"boolean", "description":"The status of Evaluation sub-category.
                                                                                                                                Enabled: Evaluation sub-category gets considered for calculating the evaluation score.
                                                                                                                                Disabled: Evaluation sub-category does not get considered for calculating the evaluation score.", "exampleSetFlag":false, "types":[ "boolean" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the sub-category in evaluation matrix.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the Evaluation sub-category and the workspace.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "ranks":{ "type":"array", "description":"The evaluation ranks of an evaluation sub-category.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityEvaluationRank", "exampleSetFlag":false }, "types":[ "array" ] }, "weight":{ "maximum":100, "minimum":1, "type":"integer", "description":"The relative weight of the sibling evaluation sub-category node. This value indicates the contribution of a given node to its parent evaluation node.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityEvaluationRankInput":{ "title":"ApiEntityEvaluationRankInput", "type":"object", "properties":{ "level":{ "type":"integer", "description":"The identifier for the order in which the ranks are displayed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "color":{ "maxLength":20, "type":"string", "description":"The color representing the evaluation ranking.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"Details describing the evaluation ranking.", "exampleSetFlag":false, "types":[ "string" ] }, "rankName":{ "maxLength":255, "type":"string", "description":"The name of the evaluation ranking.", "exampleSetFlag":false, "types":[ "string" ] }, "subCategoryId":{ "type":"integer", "description":"The unique identifier of the evaluation sub-category to which the evaluation rank is associated.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "weightPercent":{ "type":"number", "description":"The weight percentage for the evaluation ranking. This value is automatically calculated based on the number of selected ranks.", "format":"double", "exampleSetFlag":false }, "rankId":{ "type":"integer", "description":"The unique identifier for an evaluation rank.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityExchangeRate":{ "title":"ApiEntityExchangeRate", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The unique identifier for the currency. The currency code is 3 characters.", "exampleSetFlag":false, "types":[ "string" ] }, "effectiveStartDate":{ "type":"string", "description":"The date the exchange rate goes into effect.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "exchangeRateId":{ "type":"integer", "description":"The unique identifier for the exchange rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "effectiveEndDate":{ "type":"string", "description":"The date the exchange rate ends.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baseExchangeRate":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"The rate used to convert the value of a record to the base currency.", "exampleSetFlag":false, "types":[ "number" ] }, "currencyId":{ "type":"integer", "description":"The unique identifier of a currency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityExchangeRateInput":{ "title":"ApiEntityExchangeRateInput", "required":[ "baseExchangeRate", "currencyId", "effectiveStartDate" ], "type":"object", "properties":{ "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The unique identifier for the currency. The currency code is 3 characters.", "exampleSetFlag":false, "types":[ "string" ] }, "effectiveStartDate":{ "type":"string", "description":"The date the exchange rate goes into effect.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "exchangeRateId":{ "type":"integer", "description":"The unique identifier for the exchange rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "effectiveEndDate":{ "type":"string", "description":"The date the exchange rate ends.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baseExchangeRate":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"The rate used to convert the value of a record to the base currency.", "exampleSetFlag":false, "types":[ "number" ] }, "currencyId":{ "type":"integer", "description":"The unique identifier of a currency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ExchangeRate object, a unique ExchangeRate object can be identified by the following combinations of the fields.
                                                                                                                                • exchangeRateId
                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityFundActual":{ "title":"ApiEntityFundActual", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The system-generated identifier of a project actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundActualId":{ "type":"integer", "description":"The system-generated identifier of a fund actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for an actual.", "exampleSetFlag":false, "types":[ "string" ] }, "fundActualCost":{ "description":"The cost associated with the fund actual.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFundActualCost" } ] }, "fundCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of a fund.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "fundId":{ "type":"integer", "description":"The system-generated identifier of a fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundActualCost":{ "title":"ApiEntityFundActualCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "assignedCost":{ "type":"number", "description":"The portion of the fund that is assigned to the actual.", "format":"double", "exampleSetFlag":false }, "assignedCostWorkspace1":{ "type":"number", "description":"The portion of the fund that is assigned to the actual. This value is based on workspace1 currency.", "format":"double", "exampleSetFlag":false }, "assignedCostWorkspace2":{ "type":"number", "description":"The portion of the fund that is assigned to the actual. This value is based on workspace2 currency.", "format":"double", "exampleSetFlag":false }, "assignedCostWorkspace3":{ "type":"number", "description":"The portion of the fund that is assigned to the actual. This value is based on workspace3 currency.", "format":"double", "exampleSetFlag":false }, "assignedCostProject":{ "type":"number", "description":"The portion of the fund that is assigned to the actual. This value is based on project currency.", "format":"double", "exampleSetFlag":false }, "fundActualId":{ "type":"integer", "description":"The system-generated identifier of a fund actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundActualCostInput":{ "title":"ApiEntityFundActualCostInput", "type":"object", "properties":{ "assignedCostProject":{ "type":"number", "description":"The portion of the fund that is assigned to the actual. This value is based on project currency.", "format":"double", "exampleSetFlag":false }, "fundActualId":{ "type":"integer", "description":"The system-generated identifier of a fund actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityFundActualInput":{ "title":"ApiEntityFundActualInput", "required":[ "fundId", "projectActualsId" ], "type":"object", "properties":{ "projectActualsId":{ "type":"integer", "description":"The system-generated identifier of a project actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundActualId":{ "type":"integer", "description":"The system-generated identifier of a fund actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for an actual.", "exampleSetFlag":false, "types":[ "string" ] }, "fundActualCost":{ "description":"The cost associated with the fund actual.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFundActualCostInput" } ] }, "fundCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of a fund.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "fundId":{ "type":"integer", "description":"The system-generated identifier of a fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a FundActual object, a unique FundActual object can be identified by the following combinations of the fields.
                                                                                                                                  • fundActualId
                                                                                                                                  • fundId,projectActualsId
                                                                                                                                  • fundId,projectActualsCode,projectCode,workspaceCode
                                                                                                                                  • projectActualsId,fundCode,projectCode,workspaceCode
                                                                                                                                  • fundCode,projectActualsCode,projectCode,workspaceCode
                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityGlobalUserPermissionsResponse":{ "title":"ApiEntityGlobalUserPermissionsResponse", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"Profiles response with individual message and statusCodes.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfileResponse", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityGlobalProfileInput":{ "title":"ApiEntityGlobalProfileInput", "type":"object", "properties":{ "globalProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the global profile.", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityGlobalUserPermissions":{ "title":"ApiEntityGlobalUserPermissions", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityGlobalProfileInput", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityHoliday":{ "title":"ApiEntityHoliday", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "dayOfMonth":{ "type":"integer", "description":"The day of the month the holiday is on.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "dayOfWeek":{ "type":"integer", "description":"The day of the week the holiday is on.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "week":{ "type":"integer", "description":"The week of the month the holiday is in.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "month":{ "type":"integer", "description":"The month the holiday is in.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "holidayGroupName":{ "maxLength":60, "type":"string", "description":"The name of the holiday list.", "exampleSetFlag":false, "types":[ "string" ] }, "holidayId":{ "type":"integer", "description":"The unique identifier for the holiday.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "holidayName":{ "maxLength":60, "type":"string", "description":"The name of the holiday.", "exampleSetFlag":false, "types":[ "string" ] }, "holidayDate":{ "type":"string", "description":"The date of the holiday.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "holidayListId":{ "type":"integer", "description":"The unique identifier for the holiday list.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityHolidayGroup":{ "title":"ApiEntityHolidayGroup", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "holidayGroupName":{ "maxLength":60, "type":"string", "description":"The name of the holiday list.", "exampleSetFlag":false, "types":[ "string" ] }, "holidays":{ "type":"array", "description":"The list of holidays associated with the holiday group.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityHoliday", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "holidayListId":{ "type":"integer", "description":"The unique identifier for the holiday list. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityHolidayGroupInput":{ "title":"ApiEntityHolidayGroupInput", "required":[ "holidayGroupName", "workspaceId" ], "type":"object", "properties":{ "holidayGroupName":{ "maxLength":60, "type":"string", "description":"The name of the holiday list.", "exampleSetFlag":false, "types":[ "string" ] }, "holidays":{ "type":"array", "description":"The list of holidays associated with the holiday group.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityHolidayInput", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "holidayListId":{ "type":"integer", "description":"The unique identifier for the holiday list. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a HolidayGroup object, a unique HolidayGroup object can be identified by the following combinations of the fields.
                                                                                                                                    • holidayListId
                                                                                                                                    • holidayGroupName,workspaceId
                                                                                                                                    • holidayGroupName,workspaceCode
                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityHolidayInput":{ "title":"ApiEntityHolidayInput", "required":[ "holidayDate", "holidayListId", "holidayName" ], "type":"object", "properties":{ "dayOfMonth":{ "type":"integer", "description":"The day of the month the holiday is on.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "dayOfWeek":{ "type":"integer", "description":"The day of the week the holiday is on.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "week":{ "type":"integer", "description":"The week of the month the holiday is in.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "month":{ "type":"integer", "description":"The month the holiday is in.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "holidayId":{ "type":"integer", "description":"The unique identifier for the holiday.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "holidayName":{ "maxLength":60, "type":"string", "description":"The name of the holiday.", "exampleSetFlag":false, "types":[ "string" ] }, "holidayDate":{ "type":"string", "description":"The date of the holiday.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "holidayListId":{ "type":"integer", "description":"The unique identifier for the holiday list.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityIdeaUserPermissionsResponse":{ "title":"ApiEntityIdeaUserPermissionsResponse", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"Profiles response with individual message and statusCodes.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfileResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityIdeaProfileInput":{ "title":"ApiEntityIdeaProfileInput", "type":"object", "properties":{ "fileProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the document profile.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the idea profile.", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityIdeaUserPermissions":{ "title":"ApiEntityIdeaUserPermissions", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdeaProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "ideaName":{ "maxLength":255, "type":"string", "description":"The name of the Idea.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueIdea":{ "title":"ApiEntityCodeValueIdea", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueIdeaId":{ "type":"integer", "description":"The system-generated identifier of a code value idea assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityIdea":{ "title":"ApiEntityIdea", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationScore":{ "type":"number", "description":"Details describing the evaluation matrix.", "format":"double", "exampleSetFlag":false }, "owner":{ "maxLength":255, "type":"string", "description":"The user responsible for the idea.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the Idea.", "exampleSetFlag":false, "types":[ "string" ] }, "statusReason":{ "maxLength":4000, "type":"string", "description":"The reason the idea status was changed.", "exampleSetFlag":false, "types":[ "string" ] }, "submitUser":{ "maxLength":255, "type":"string", "description":"The user who submitted the idea.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaName":{ "maxLength":255, "type":"string", "description":"The name of the Idea.", "exampleSetFlag":false, "types":[ "string" ] }, "proposedSolution":{ "maxLength":4000, "type":"string", "description":"The proposed solution to the problem the idea addresses.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValuesIdea":{ "type":"array", "description":"The list of code values for an idea. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueIdea", "exampleSetFlag":false }, "types":[ "array" ] }, "benefits":{ "maxLength":4000, "type":"string", "description":"A description of the anticipated benefits of implementing the idea.", "exampleSetFlag":false, "types":[ "string" ] }, "statusDate":{ "type":"string", "description":"The date and time the idea status was changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "problemOrOpportunity":{ "maxLength":4000, "type":"string", "description":"A detailed description of the problem or opportunity the idea addresses.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "submitDate":{ "type":"string", "description":"The date and time the idea was submitted.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for an idea.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdeaConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "updateUser":{ "maxLength":255, "type":"string", "description":"The user who last updated the idea.", "exampleSetFlag":false, "types":[ "string" ] }, "createDate":{ "type":"string", "description":"The date and time when the idea was created.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "createUser":{ "maxLength":255, "type":"string", "description":"The user who created the idea.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"The status of the idea. Valid values are new, accepted, rejected, and owner assigned.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NEW", "SUBMITTED", "ACCEPTED", "REJECTED", "OWNER_ASSIGNED", "PROPOSAL" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityIdeaConfiguredFieldValue":{ "title":"ApiEntityIdeaConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "ideaConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the idea configured field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueIdeaInput":{ "title":"ApiEntityCodeValueIdeaInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueIdeaId":{ "type":"integer", "description":"The system-generated identifier of a code value idea assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueIdea object, a unique CodeValueIdea object can be identified by the following combinations of the fields.
                                                                                                                                      • codeValueIdeaId
                                                                                                                                      • codeValueId
                                                                                                                                      • codeTypeCode,codeValueCode
                                                                                                                                      • codeTypeCode,codeValueCode,parentId
                                                                                                                                      • codeValueCode,codeTypeId,parentId
                                                                                                                                      • codeTypeId,codeValueCode
                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityIdeaConfiguredFieldValueInput":{ "title":"ApiEntityIdeaConfiguredFieldValueInput", "type":"object", "properties":{ "ideaConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the idea configured field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a IdeaConfiguredFieldValue object, a unique IdeaConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                        • ideaConfiguredFieldValueId
                                                                                                                                        • columnDefinitionId
                                                                                                                                        • columnName
                                                                                                                                        • columnLabel
                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityIdeaInput":{ "title":"ApiEntityIdeaInput", "required":[ "ideaName", "workspaceId" ], "type":"object", "properties":{ "evaluationScore":{ "type":"number", "description":"Details describing the evaluation matrix.", "format":"double", "exampleSetFlag":false }, "owner":{ "maxLength":255, "type":"string", "description":"The user responsible for the idea.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the Idea.", "exampleSetFlag":false, "types":[ "string" ] }, "statusReason":{ "maxLength":4000, "type":"string", "description":"The reason the idea status was changed.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaName":{ "maxLength":255, "type":"string", "description":"The name of the Idea.", "exampleSetFlag":false, "types":[ "string" ] }, "proposedSolution":{ "maxLength":4000, "type":"string", "description":"The proposed solution to the problem the idea addresses.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValuesIdea":{ "type":"array", "description":"The list of code values for an idea. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueIdeaInput", "exampleSetFlag":false }, "types":[ "array" ] }, "benefits":{ "maxLength":4000, "type":"string", "description":"A description of the anticipated benefits of implementing the idea.", "exampleSetFlag":false, "types":[ "string" ] }, "problemOrOpportunity":{ "maxLength":4000, "type":"string", "description":"A detailed description of the problem or opportunity the idea addresses.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for an idea.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityIdeaConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the idea. Valid values are new, accepted, rejected, and owner assigned.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NEW", "SUBMITTED", "ACCEPTED", "REJECTED", "OWNER_ASSIGNED", "PROPOSAL" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a Idea object, a unique Idea object can be identified by the following combinations of the fields.
                                                                                                                                          • ideaId
                                                                                                                                          • ideaName,workspaceId
                                                                                                                                          • ideaName,workspaceCode
                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityRemoveIdeaUserPermissionsResponse":{ "title":"ApiEntityRemoveIdeaUserPermissionsResponse", "type":"object", "properties":{ "message":{ "type":"string", "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveIdeaUserPermissions":{ "title":"ApiEntityRemoveIdeaUserPermissions", "type":"object", "properties":{ "userNames":{ "type":"array", "description":"List of user names for removing users.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "ideaName":{ "maxLength":255, "type":"string", "description":"The name of the Idea.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "ideaId":{ "type":"integer", "description":"The system-generated identifier of an idea.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityLocation":{ "title":"ApiEntityLocation", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional details about the location.", "exampleSetFlag":false, "types":[ "string" ] }, "locationId":{ "type":"integer", "description":"The unique identifier for the location.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "locationCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of the location.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the location.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the location and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "locationName":{ "maxLength":255, "minLength":1, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                            This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                            This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "minLength":0, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location. The value is expressed as a three letter code.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityLocationInput":{ "title":"ApiEntityLocationInput", "required":[ "locationName", "workspaceId" ], "type":"object", "properties":{ "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional details about the location.", "exampleSetFlag":false, "types":[ "string" ] }, "locationId":{ "type":"integer", "description":"The unique identifier for the location.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "locationCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of the location.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the location.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "locationName":{ "maxLength":255, "minLength":1, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                            This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                            This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "minLength":0, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location. The value is expressed as a three letter code.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a Location object, a unique Location object can be identified by the following combinations of the fields.
                                                                                                                                            • locationId
                                                                                                                                            • locationCode,workspaceId
                                                                                                                                            • locationCode,workspaceCode
                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityMonteCarloActivityDelta":{ "title":"ApiEntityMonteCarloActivityDelta", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloActivityDeltaFinancial":{ "description":"An object containing all the financial fields of a Monte Carlo activity delta in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityMonteCarloActivityDeltaFinancial" } ] }, "monteCarloActivityDeltaId":{ "type":"integer", "description":"The unique identifier of an activity delta.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pessimisticStartDeltaAbs":{ "type":"number", "description":"Duration difference between the pre-response and post-response pessimistic start date values.", "format":"double", "exampleSetFlag":false }, "pessimisticStartDeltaPct":{ "type":"number", "description":"Percentage difference between the pre-response and post-response pessimistic start date values. ", "format":"double", "exampleSetFlag":false }, "pessimisticFinishDeltaAbs":{ "type":"number", "description":"Duration difference between the pre-response and post-response pessimistic finish dates.", "format":"double", "exampleSetFlag":false }, "pessimisticFinishDeltaPct":{ "type":"number", "description":"Percentage difference between the pre-response and post-response pessimistic finish dates.", "format":"double", "exampleSetFlag":false }, "pessimisticDurationDeltaAbs":{ "type":"number", "description":"Duration difference between the pre-response and post-response remaining duration values.", "format":"double", "exampleSetFlag":false }, "pessimisticDurationDeltaPct":{ "type":"number", "description":"Percentage difference between the pre-response and post-response remaining duration values.", "format":"double", "exampleSetFlag":false }, "activityId":{ "type":"integer", "description":"The unique identifier of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloActivityDeltaFinancial":{ "title":"ApiEntityMonteCarloActivityDeltaFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloActivityDeltaId":{ "type":"integer", "description":"The unique identifier of an activity cost delta.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "atCompletionPessimisticCostDeltaAbs":{ "type":"number", "description":"The cost difference between the pre-response and post-response at-completion cost values.", "format":"double", "exampleSetFlag":false }, "atCompletionPessimisticCostDeltaPct":{ "type":"number", "description":"The percentage difference between the pre-response and post-response at-completion cost values.", "format":"double", "exampleSetFlag":false }, "pessimisticCostDeltaAbs":{ "type":"number", "description":"Cost difference between the pre-response and post-response remaining cost values.", "format":"double", "exampleSetFlag":false }, "pessimisticCostDeltaPct":{ "type":"number", "description":"Percentage difference between the pre-response and post-response remaining cost values.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloActivityDeterministicFinancialValues":{ "title":"ApiEntityMonteCarloActivityDeterministicFinancialValues", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloActivityDeterministicValuesId":{ "type":"integer", "description":"The unique identifier of an activity deterministic cost.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloActivityDeterministicId":{ "type":"integer", "description":"The system generated identifier of the object that holds the remaining cost of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "remainingNonLaborCost":{ "type":"number", "description":"The activity remaining nonlabor cost at the time the risk analysis was run. ", "format":"double", "exampleSetFlag":false }, "remainingLaborCost":{ "type":"number", "description":"The activity remaining labor cost at the time the risk analysis was run. ", "format":"double", "exampleSetFlag":false }, "remainingMaterialCost":{ "type":"number", "description":"The activity remaining material cost at the time the risk analysis was run. ", "format":"double", "exampleSetFlag":false }, "atCompletionTotalCost":{ "type":"number", "description":"The activity at completion total cost at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "deterministicActualCost":{ "type":"number", "description":"The activity actual cost at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The project remaining cost calculated using fixed cost values.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloActivityDeterministicValues":{ "title":"ApiEntityMonteCarloActivityDeterministicValues", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloActivityDeterministicFinancialValues":{ "description":"An object containing all Monte Carlo activity deterministic value financial fields in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityMonteCarloActivityDeterministicFinancialValues" } ] }, "maximumRemainingDuration":{ "type":"number", "description":"The activity maximum duration at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "minimumRemainingDuration":{ "type":"number", "description":"The activity minimum duration at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "mostLikelyRemainingDuration":{ "type":"number", "description":"The activity most likely duration at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "monteCarloActivityDeterministicValuesId":{ "type":"integer", "description":"The unique identifier of a Monte Carlo deterministic activity analysis.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarId":{ "type":"integer", "description":"The system-generated unique identifier of the calendar which was assigned to the activity at the time the risk analysis was run.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarName":{ "maxLength":255, "type":"string", "description":"The calendar assigned to the activity at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The unique identifier of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
                                                                                                                                              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                                                                                                                                              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                                                                                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "activityStatus":{ "type":"string", "description":"The status of an activity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "startDate":{ "type":"string", "description":"The activity start date calculated using fixed activity dates and durations without taking into account the impact of risks and activity uncertainty on the project schedule.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The activity finish date calculated using fixed activity dates and durations without taking into account the impact of risks and activity uncertainty on the project schedule.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The remaining duration of an activity calculated using fixed activity dates and durations without taking into account the impact of risks and activity uncertainty on the project schedule.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The activity ID at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ] }, "activityName":{ "maxLength":255, "type":"string", "description":"The activity name at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ] }, "activityType":{ "type":"string", "description":"The activity type at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "RESOURCE_DEPENDENT", "LEVEL_OF_EFFORT", "START_MILESTONE", "FINISH_MILESTONE", "WBS_SUMMARY" ] }, "actualDuration":{ "type":"number", "description":"The activity actual duration at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "actualFinishDate":{ "type":"string", "description":"The activity actual finish at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStartDate":{ "type":"string", "description":"The activity actual start at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "assignedRisks":{ "maxLength":3855, "type":"string", "description":"The risks assigned to the activity at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ] }, "atCompletionDuration":{ "type":"number", "description":"The activity at completion duration at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "primaryConstraintDate":{ "type":"string", "description":"The activity primary constraint date at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "primaryConstraintType":{ "type":"string", "description":"The activity primary constraint at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "isCritical":{ "type":"boolean", "description":"The activity critical value at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "boolean" ] }, "distributionShape":{ "type":"string", "description":"The activity uncertainty distribution at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "drivingPath":{ "type":"boolean", "description":"The activity longest path value at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "boolean" ] }, "earlyFinishDate":{ "type":"string", "description":"The activity early finish at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyStartDate":{ "type":"string", "description":"The activity early start at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "expectedFinishDate":{ "type":"string", "description":"The activity expected finish at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "freeFloat":{ "type":"number", "description":"The activity free float at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "lateFinishDate":{ "type":"string", "description":"The activity late finish at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lateStartDate":{ "type":"string", "description":"The activity late start at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "resumeDate":{ "type":"string", "description":"The activity resume date at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintDate":{ "type":"string", "description":"The activity secondary constraint date at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "secondaryConstraintType":{ "type":"string", "description":"The activity secondary constraint at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ] }, "suspendDate":{ "type":"string", "description":"The activity suspend date at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "totalFloat":{ "type":"number", "description":"The activity total float at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "updateUser":{ "maxLength":255, "type":"string", "description":"The username of the user who last modified the record.", "exampleSetFlag":false, "types":[ "string" ] }, "createDate":{ "type":"string", "description":"The date the record was created.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "createUser":{ "maxLength":255, "type":"string", "description":"The username of the user who created the record.", "exampleSetFlag":false, "types":[ "string" ] }, "updateOnBehalfOfUser":{ "maxLength":255, "type":"string", "description":"The username of the user who updated the record on behalf of another user.", "exampleSetFlag":false, "types":[ "string" ] }, "createOnBehalfOfUser":{ "maxLength":255, "type":"string", "description":"The username of the user who created the record on behalf of another user.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"The system-generated unique identifier of the WBS which was assigned to the activity at the time the risk analysis was run.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsCode":{ "maxLength":60, "type":"string", "description":"The activity WBS code at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ] }, "wbsName":{ "maxLength":255, "type":"string", "description":"The activity WBS at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloActivityIterationValue":{ "title":"ApiEntityMonteCarloActivityIterationValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "totalNonLaborCostRiskFactor":{ "type":"number", "description":"The combined nonlabor risk factor.", "format":"double", "exampleSetFlag":false }, "totalMaterialsCostRiskFactor":{ "type":"number", "description":"The combined material risk factor.", "format":"double", "exampleSetFlag":false }, "remainingLaborCostImpact":{ "type":"number", "description":"For the iteration, the risk factor labor cost impact.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborCostImpact":{ "type":"number", "description":"For the iteration, the risk factor nonlabor cost impact.", "format":"double", "exampleSetFlag":false }, "remainingMaterialsCostImpact":{ "type":"number", "description":"For the iteration, the risk factor material cost impact.", "format":"double", "exampleSetFlag":false }, "uncertaintyScheduleImpact":{ "type":"number", "description":"For the iteration, the difference between the activity deterministic remaining duration and the duration sampled from the activity Uncertainty Distribution. The value can be positive or negative. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "riskScheduleDrivenCostImpact":{ "type":"number", "description":"Total cost impact due to scheduling on the activity for the iteration. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "uncertaintyScheduleDrivenCostImpact":{ "type":"number", "description":"Total cost impact due to uncertainty on the activity for the iteration. Stored for the first 50 iterations only. ", "format":"double", "exampleSetFlag":false }, "otherScheduleDrivenCostImpact":{ "type":"number", "description":"Other cost impact on the activity for the iteration. Stored for the first 50 iterations only. ", "format":"double", "exampleSetFlag":false }, "remainingDurationWithUncertainty":{ "type":"number", "description":"For the iteration, the activity remaining duration after any duration uncertainty impact prior to any other schedule impacts. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "riskFactorScheduleImpact":{ "type":"number", "description":"For the iteration, the change in the activity remaining duration due to risk factors impacting the activity. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "riskFactorScheduleCostImpact":{ "type":"number", "description":"For the iteration, the activity cost change due to any risk factor schedule impacts. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "remainingLaborCostBeforeRiskFactor":{ "type":"number", "description":"For the iteration, the activity remaining labor cost before cost risk factors have impacted. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "remainingMaterialsCostBeforeRiskFactor":{ "type":"number", "description":"For the iteration, the activity remaining material cost before cost risk factors have impacted. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "totalLaborCostRiskFactor":{ "type":"number", "description":"The combined labor risk factor. ", "format":"double", "exampleSetFlag":false }, "remainingNonLaborCostBeforeRiskFactor":{ "type":"number", "description":"For the iteration, the activity remaining nonlabor cost before cost risk factors have impacted. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "projectScenarioId":{ "type":"integer", "description":"The system-generated unique identifier of the project scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "iterationNumber":{ "type":"integer", "description":"The iteration sequence number.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "uncertaintyDelay":{ "type":"number", "description":"The activity mean delay for the iteration. Stored for all iterations.", "format":"double", "exampleSetFlag":false }, "totalWeatherDelay":{ "type":"integer", "description":"The number of weather non-working days between the start and finish of the activity for the iteration. Weather non-working time that coincides with other non-working weather time on the activity time is included. Stored for the first 50 iterations only.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScheduleImpact":{ "type":"number", "description":"For the iteration, the change in the activity remaining duration due to threats and opportunities impacting the activity. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "totalScheduleImpact":{ "type":"number", "description":"For the iteration, the difference between the activity iteration remaining duration and the activity deterministic remaining duration. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "remainingEarlyStartDate":{ "type":"string", "description":"The activity remaining early start for the iteration. Stored for the first 50 iterations only.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "impactBarStartDate":{ "type":"string", "description":"If an activity has a schedule impact, then the Impact Bar Start Date is the start date that the impact on the activity Gantt bar is drawn from for the iteration. Stored for the first 50 iterations only.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "impactingRisks":{ "maxLength":3855, "type":"string", "description":"The risks that impacted the activity for the iteration. Stored for the first 50 iterations only.", "exampleSetFlag":false, "types":[ "string" ] }, "riskCostImpact":{ "type":"number", "description":"For the iteration, the total of the cost impacts on the activity due to threats and opportunities impacting the activity. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "indirectDurationImpact":{ "type":"number", "description":"For the iteration, the variation between the activity deterministic remaining duration and the activity iteration remaining duration that is not due to threats, opportunities, uncertainty or risk factors. Stored for first 50 iterations.", "format":"double", "exampleSetFlag":false }, "totalCostImpact":{ "type":"number", "description":"Total cost impact due to risks on the activity for the iteration. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "totalScheduleRiskFactor":{ "type":"number", "description":"For the iteration, the combined schedule impact percentage for all risk factors impacting the activity. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "totalScheduleCostImpact":{ "type":"number", "description":"For the iteration, the activity cost change due to all schedule impacts. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "riskFactorCostImpact":{ "type":"number", "description":"For the iteration, the activity cost change due to any risk factor cost impacts. This does not include any cost impacts caused by schedule impacts. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "remainingMaterialsCost":{ "type":"number", "description":"For the iteration, the activity remaining material cost. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "remainingNonLaborCost":{ "type":"number", "description":"For the iteration, the activity remaining nonlabor cost. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "remainingLaborCost":{ "type":"number", "description":"For the iteration, the activity remaining labor cost. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "remainingTotalCost":{ "type":"number", "description":"The activity remaining total cost for the iteration. Stored for all iterations.", "format":"double", "exampleSetFlag":false }, "atCompletionTotalCost":{ "type":"number", "description":"The activity at completion total cost for the iteration. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The system-generated unique identifier of the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
                                                                                                                                              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                                                                                                                                              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                                                                                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "startDate":{ "type":"string", "description":"The activity start date for the iteration. Stored for the first 50 iterations only.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The activity finish date for the iteration. Stored for the first 50 iterations only.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"For the iteration, the activity remaining duration. Note: If the impacted activity remaining duration is negative then the activity remaining duration is set to 1 minute because negative duration values are not supported. Stored for all iterations.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "atCompletionDuration":{ "type":"number", "description":"The activity at completion duration for the iteration. Stored for first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "isCritical":{ "type":"boolean", "description":"The activity critical value for the iteration. Stored for all iterations.", "exampleSetFlag":false, "types":[ "boolean" ] }, "drivingPath":{ "type":"boolean", "description":"The activity longest path value for the iteration. Stored for the first 50 iterations only.", "exampleSetFlag":false, "types":[ "boolean" ] }, "earlyFinishDate":{ "type":"string", "description":"The activity early finish date for the iteration. Stored for all iterations.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyStartDate":{ "type":"string", "description":"The activity early start date for the iteration. Stored for all iterations.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "freeFloat":{ "type":"number", "description":"The activity free float for the iteration. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "lateFinishDate":{ "type":"string", "description":"The activity late finish date for the iteration. Stored for the first 50 iterations only.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lateStartDate":{ "type":"string", "description":"The activity late start date for the iteration. Stored for the first 50 iterations only.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "totalFloat":{ "type":"number", "description":"The activity total float for the iteration. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "removedItemType":{ "type":"string", "description":"The type of removed item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "0", "1", "2", "3", "4", "5" ] }, "removedItemId":{ "type":"integer", "description":"The system-generated identifier of the removed risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The system-generated unique identifier of the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloActivityResult":{ "title":"ApiEntityMonteCarloActivityResult", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloActivityRiskResults":{ "type":"array", "description":"List of associated activity risk results.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMonteCarloActivityRiskResult", "exampleSetFlag":false }, "types":[ "array" ] }, "monteCarloActivityResultId":{ "type":"integer", "description":"The unique identifier of an activity result.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloActivityResultFinancial":{ "description":"An object containing the associated financial fields.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityMonteCarloActivityResultFinancial" } ] }, "deterministicStartProbability":{ "type":"number", "description":"The probability of the project starting on or before the deterministic start date.", "format":"double", "exampleSetFlag":false }, "deterministicFinishProbability":{ "type":"number", "description":"The probability of the project finishing on or before the deterministic finish date.", "format":"double", "exampleSetFlag":false }, "deterministicDurationProbability":{ "type":"number", "description":"The probability of the project's remaining duration being less than or equal to the project remaining duration, calculated using fixed duration and date values.", "format":"double", "exampleSetFlag":false }, "pessimisticStartContingency":{ "type":"number", "description":"The difference between the project pessimistic percentile start date and the project deterministic start date.", "format":"double", "exampleSetFlag":false }, "pessimisticFinishContingency":{ "type":"number", "description":"The difference between the project pessimistic percentile finish date and the project deterministic finish date.", "format":"double", "exampleSetFlag":false }, "pessimisticDurationContingency":{ "type":"number", "description":"The difference between the project pessimistic percentile remaining duration and the project deterministic remaining duration.", "format":"double", "exampleSetFlag":false }, "activityId":{ "type":"integer", "description":"The unique identifier of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
                                                                                                                                              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                                                                                                                                              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                                                                                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "activityStatus":{ "type":"string", "description":"Activity Status.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "pessimisticStartDate":{ "type":"string", "description":"The calculated activity start date that corresponds to the defined pessimistic percentile on the risk analysis histogram.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "optimisticDuration":{ "type":"number", "description":"The optimistic remaining duration calculated using the optimistic percentile.", "format":"double", "exampleSetFlag":false }, "pessimisticFinishDate":{ "type":"string", "description":"The calculated project finish date that corresponds to the defined pessimistic percentile.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "optimisticFinishDate":{ "type":"string", "description":"The calculated activity finish date that corresponds to the defined optimistic percentile on the risk analysis histogram.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "removedItemType":{ "type":"string", "description":"The type of removed item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "0", "1", "2", "3", "4", "5" ] }, "removedItemId":{ "type":"integer", "description":"The system-generated identifier of the removed risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "optimisticStartDate":{ "type":"string", "description":"The calculated activity start date that corresponds to the defined optimistic percentile on the risk analysis histogram.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "criticalIndex":{ "type":"number", "description":"During risk analysis, tasks can join or leave the critical path. The criticality index expresses as a percentage, how often a particular task was on the critical path during the analysis.", "format":"double", "exampleSetFlag":false }, "p50Duration":{ "type":"number", "description":"The calculated median remaining duration.", "format":"double", "exampleSetFlag":false }, "p50FinishDate":{ "type":"string", "description":"The calculated activity finish date that corresponds to the median percentile on the risk analysis histogram.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "pessimisticDuration":{ "type":"number", "description":"The pessimistic remaining duration calculated using the pessimistic percentile.", "format":"double", "exampleSetFlag":false }, "p50StartDate":{ "type":"string", "description":"The calculated activity start date that corresponds to the median percentile on the risk analysis histogram.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "uncertaintyMeanDelay":{ "type":"number", "description":"The estimated average project delay duration before implementing a response action.", "format":"double", "exampleSetFlag":false }, "minStartDate":{ "type":"string", "description":"The earliest project start date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "maxStartDate":{ "type":"string", "description":"The latest project start date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "minFinishDate":{ "type":"string", "description":"The earliest project finish date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "maxFinishDate":{ "type":"string", "description":"The latest project finish date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "minDuration":{ "type":"number", "description":"The minimum project remaining duration sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "maxDuration":{ "type":"number", "description":"The maximum project remaining duration sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "totalMeanDelay":{ "type":"number", "description":"Activity uncertainty Total Delay Contribution for an activity averaged over total number of iterations in the analysis.", "format":"double", "exampleSetFlag":false }, "indirectMeanDelay":{ "type":"number", "description":"The contribution to the project mean delay from the activity indirect mean delay.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloActivityResultFinancial":{ "title":"ApiEntityMonteCarloActivityResultFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "deterministicAtCompletionCostProbability":{ "type":"number", "description":"The probability of achieving the deterministic at-completion cost.", "format":"double", "exampleSetFlag":false }, "monteCarloActivityResultId":{ "type":"integer", "description":"The unique identifier of an activity result cost entity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pessimisticCostContingency":{ "type":"number", "description":"The difference between the project pessimistic remaining cost and the project deterministic remaining cost.", "format":"double", "exampleSetFlag":false }, "deterministicCostProbability":{ "type":"number", "description":"The probability of achieving the project deterministic remaining cost.", "format":"double", "exampleSetFlag":false }, "optimisticAtCompletionCost":{ "type":"number", "description":"The optimistic at-completion cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "pessimisticAtCompletionCost":{ "type":"number", "description":"The pessimistic at-completion cost calculated using the pessimistic percentile. ", "format":"double", "exampleSetFlag":false }, "pessimisticAtCompletionCostContingency":{ "type":"number", "description":"The difference between the pessimistic at-completion cost and the deterministic at-completion cost.", "format":"double", "exampleSetFlag":false }, "totalAtCompletionMeanCostImpact":{ "type":"number", "description":"The total amount the activity contributes to the project total mean at-completion cost", "format":"double", "exampleSetFlag":false }, "optimisticCost":{ "type":"number", "description":"The optimistic remaining cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "pessimisticCost":{ "type":"number", "description":"The pessimistic remaining cost calculated using the pessimistic percentile.", "format":"double", "exampleSetFlag":false }, "totalMeanCostImpact":{ "type":"number", "description":"The estimated average project cost impact before implementing a response action.", "format":"double", "exampleSetFlag":false }, "p50AtCompletionCost":{ "type":"number", "description":"The P50 or median at-completion cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "minimumAtCompletionCost":{ "type":"number", "description":"The minimum at-completion cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "maximumAtCompletionCost":{ "type":"number", "description":"The maximum at-completion cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "p50Cost":{ "type":"number", "description":"The P50 or median remaining cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "minCost":{ "type":"number", "description":"The minimum project remaining cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "maxCost":{ "type":"number", "description":"The maximum project remaining cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloActivityRiskResult":{ "title":"ApiEntityMonteCarloActivityRiskResult", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloActivityRiskResultFinancial":{ "description":"The financial data associated with the activity risk result.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityMonteCarloActivityRiskResultFinancial" } ] }, "monteCarloActivityRiskResultId":{ "type":"integer", "description":"The unique identifier of a risk result.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloActivityResultId":{ "type":"integer", "description":"The unique identifier of a Monte Carlo risk result.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project to which a risk is assigned.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "meanDelay":{ "type":"number", "description":"Estimated average project delay duration before implementing a response action.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloActivityRiskResultFinancial":{ "title":"ApiEntityMonteCarloActivityRiskResultFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloActivityRiskResultId":{ "type":"integer", "description":"The unique identifier of an activity risk result.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "meanCostImpact":{ "type":"number", "description":"The estimated average project cost impact before implementing a response action.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloProjectDelta":{ "title":"ApiEntityMonteCarloProjectDelta", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloProjectDeltaFinancial":{ "description":"An object containing Monte Carlo project delta financial fields in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDeltaFinancial" } ] }, "monteCarloProjectDeltaId":{ "type":"integer", "description":"The system-generated identifier of the project delta.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pessimisticStartDeltaAbs":{ "type":"number", "description":"The duration difference between the pre-response and post-response pessimistic start date values.", "format":"double", "exampleSetFlag":false }, "pessimisticStartDeltaPct":{ "type":"number", "description":"Duration of difference between the pre-response and post-response pessimistic start date values represented as a percentage. ", "format":"double", "exampleSetFlag":false }, "pessimisticFinishDeltaAbs":{ "type":"number", "description":"The duration difference between the pre-response and post-response pessimistic finish dates.", "format":"double", "exampleSetFlag":false }, "pessimisticFinishDeltaPct":{ "type":"number", "description":"Duration of difference between the pre-response and post-response pessimistic finish dates represented as a percentage.", "format":"double", "exampleSetFlag":false }, "pessimisticDurationDeltaAbs":{ "type":"number", "description":"The duration difference between the Pre-Response and Post-Response remaining duration values.", "format":"double", "exampleSetFlag":false }, "pessimisticDurationDeltaPct":{ "type":"number", "description":"The percentage difference between the Pre-Response and Post-Response remaining duration values.", "format":"double", "exampleSetFlag":false }, "monteCarloDeltaScenario":{ "type":"string", "description":"The type of the risk analysis scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORG_PRE_TO_ORG_POST", "ORG_PRE_TO_SENS_PRE", "ORG_POST_TO_SENS_POST", "PRE_MEAN_IMPACTED", "POST_MEAN_IMPACTED" ] }, "removedItemType":{ "type":"string", "description":"Type of removed item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY_UNCERTAINTY", "NONE", "RISK" ] }, "removedItemId":{ "type":"integer", "description":"The system-generated identifier of the removed risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier of the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloProjectDeltaFinancial":{ "title":"ApiEntityMonteCarloProjectDeltaFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloProjectDeltaId":{ "type":"integer", "description":"The unique identifier of a project cost delta.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "atCompletionPessimisticCostDeltaAbs":{ "type":"number", "description":"The cost difference between the pre-response and post-response at-completion cost values.", "format":"double", "exampleSetFlag":false }, "atCompletionPessimisticCostDeltaPct":{ "type":"number", "description":"The percentage difference between the pre-response and post-response at-completion cost values.", "format":"double", "exampleSetFlag":false }, "pessimisticCostDeltaAbs":{ "type":"number", "description":"The cost difference between the Pre-Response and Post-Response remaining cost values.", "format":"double", "exampleSetFlag":false }, "pessimisticCostDeltaPct":{ "type":"number", "description":"The percentage difference between the Pre-Response and Post-Response remaining cost values.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloProjectDeterministicFinancialValues":{ "title":"ApiEntityMonteCarloProjectDeterministicFinancialValues", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "totalDirectResponseRemainingCost":{ "type":"number", "description":"The project total direct response remaining cost at the time the risk analysis as run.", "format":"double", "exampleSetFlag":false }, "totalDirectResponseActualCost":{ "type":"number", "description":"The project total direct response actual cost at the time the risk analysis as run.", "format":"double", "exampleSetFlag":false }, "monteCarloProjectDeterministicId":{ "type":"integer", "description":"The system-generated identifier of the project deterministic value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloProjectDeterministicValuesId":{ "type":"integer", "description":"The unique identifier of a project deterministic cost.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "deterministicActualCost":{ "type":"number", "description":"The project actual cost at the time the risk analysis as run.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The project remaining total cost plus unmapped response action remaining costs at the time the risk analysis as run. ", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The sum of the activity at-completion costs at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloProjectDeterministicValues":{ "title":"ApiEntityMonteCarloProjectDeterministicValues", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloProjectDeterministicFinancialValues":{ "description":"An object containing Monte Carlo project deterministic financial fields in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityMonteCarloProjectDeterministicFinancialValues" } ] }, "monteCarloProjectDeterministicValuesId":{ "type":"integer", "description":"The system-generated identifier of the project deterministic value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The project name at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ] }, "scheduledFinishDate":{ "type":"string", "description":"The project schedule finish date at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The project code at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
                                                                                                                                              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                                                                                                                                              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                                                                                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "startDate":{ "type":"string", "description":"The project start date at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The project finish date at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The project schedule remaining duration at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "actualDuration":{ "type":"number", "description":"The project actual duration at the time the risk analysis was run.", "format":"double", "exampleSetFlag":false }, "actualFinishDate":{ "type":"string", "description":"The project actual finish date at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStartDate":{ "type":"string", "description":"The project actual start date at the time the risk analysis was run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "assignedRisks":{ "maxLength":3855, "type":"string", "description":"The risks assigned to the project at the time the risk analysis was run.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier of the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloProjectIterationValue":{ "title":"ApiEntityMonteCarloProjectIterationValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "projectDirectRemainingDuration":{ "type":"number", "description":"The project direct remaining duration due to project risks for the iteration. Stored for all iterations.", "format":"double", "exampleSetFlag":false }, "projectTotalDirectRemainingCost":{ "type":"number", "description":"The project direct remaining cost due to project risks for the iteration. Stored for all iterations.", "format":"double", "exampleSetFlag":false }, "projectTotalDirectAtCompletionCost":{ "type":"number", "description":"The project direct at completion cost due to project risks for the iteration. Stored for all iterations.", "format":"double", "exampleSetFlag":false }, "iterationBlock":{ "type":"integer", "description":"The iteration block number.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCostImpactProject":{ "type":"number", "description":"The total for the iteration of all of the project-level risk cost impacts. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "riskCostImpactTotal":{ "type":"number", "description":"The total for the iteration of all the project-level and activity level risk cost impacts. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "risksImpactingProject":{ "maxLength":0, "type":"string", "description":"The project risks that impacted the project for the iteration. Stored for the first 50 iterations only.", "exampleSetFlag":false, "types":[ "string" ] }, "projectScenarioId":{ "type":"integer", "description":"The system-generated unique identifier of the project scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "iterationNumber":{ "type":"integer", "description":"The iteration sequence number.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "uncertaintyDelay":{ "type":"number", "description":"The project mean schedule delay for the iteration. Stored for all iterations.", "format":"double", "exampleSetFlag":false }, "impactBarStartDate":{ "type":"string", "description":"The start date that the project impact bar starts on. Stored for the first 50 iterations only.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "atCompletionTotalCost":{ "type":"number", "description":"The project at completion total cost for the iteration. Stored for the first 50 iterations only.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
                                                                                                                                              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                                                                                                                                              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                                                                                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "remainingDuration":{ "type":"number", "description":"The project remaining duration for the iteration. Stored for all iterations.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "earlyFinishDate":{ "type":"string", "description":"The project finish date for the iteration. Stored for all iterations.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "earlyStartDate":{ "type":"string", "description":"The project start date for the iteration. Stored for all iterations.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingCost":{ "type":"number", "description":"The project total remaining duration for the iteration. Stored for all iterations.", "format":"double", "exampleSetFlag":false }, "removedItemType":{ "type":"string", "description":"The type of removed item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY_UNCERTAINTY", "NONE", "RISK" ] }, "removedItemId":{ "type":"integer", "description":"The system-generated identifier of the removed risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The system-generated unique identifier of the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloProjectResult":{ "title":"ApiEntityMonteCarloProjectResult", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloProjectResultFinancial":{ "description":"An object containing Monte Carlo project result financial fields in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityMonteCarloProjectResultFinancial" } ] }, "monteCarloProjectResultId":{ "type":"integer", "description":"The unique identifier of a project Monte Carlo analysis result.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "totalUncertaintyMeanDelay":{ "type":"number", "description":"The total uncertainty mean delay contained in a Monte Carlo analysis result.", "format":"double", "exampleSetFlag":false }, "deterministicStartProbability":{ "type":"number", "description":"The probability of the project starting on or before the deterministic start date.", "format":"double", "exampleSetFlag":false }, "deterministicFinishProbability":{ "type":"number", "description":"The probability of the project finishing on or before the deterministic finish date.", "format":"double", "exampleSetFlag":false }, "deterministicDurationProbability":{ "type":"number", "description":"The probability of the project's remaining duration being less than or equal to the project remaining duration, calculated using fixed duration and date values.", "format":"double", "exampleSetFlag":false }, "pessimisticStartContingency":{ "type":"number", "description":"The difference between the project pessimistic percentile start date and the project deterministic start date.", "format":"double", "exampleSetFlag":false }, "pessimisticFinishContingency":{ "type":"number", "description":"The difference between the project pessimistic percentile finish date and the project deterministic finish date.", "format":"double", "exampleSetFlag":false }, "pessimisticDurationContingency":{ "type":"number", "description":"The difference between the project pessimistic percentile remaining duration and the project deterministic remaining duration.", "format":"double", "exampleSetFlag":false }, "meanStart":{ "type":"string", "description":"The average project start date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "meanFinish":{ "type":"string", "description":"The average project finish date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "meanDuration":{ "type":"number", "description":"The average project remaining duration sampled during risk analysis.", "format":"double", "exampleSetFlag":false }, "durationVariance":{ "type":"number", "description":"Variance between project remaining hours in a Monte Carlo analysis result.", "exampleSetFlag":false, "types":[ "number" ] }, "durationStdDeviation":{ "type":"number", "description":"How much the variation of remaining durations deviates from the calculated mean remaining duration.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "startVariance":{ "type":"number", "description":"Variance between project start dates in a Monte Carlo analysis result.", "exampleSetFlag":false, "types":[ "number" ] }, "startStdDeviation":{ "type":"number", "description":"How much the variation of project start dates deviate from the calculated mean start date.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "finishVariance":{ "type":"number", "description":"Variance between project finish dates in a Monte Carlo analysis result.", "exampleSetFlag":false, "types":[ "number" ] }, "finishStdDeviation":{ "type":"number", "description":"How much the project finish dates deviate from the calculated mean finish date.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "totalMeanDelayPercent":{ "type":"number", "description":"The average delay percentage of the remaining duration for the project.
                                                                                                                                              Calculated as Project Mean Delay divided by Project Remaining Duration multiplied by 100.", "format":"double", "exampleSetFlag":false }, "meanIndirectDelay":{ "type":"number", "description":"Project total mean activity indirect impact normalized delay in hours. ", "format":"double", "exampleSetFlag":false }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
                                                                                                                                              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                                                                                                                                              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                                                                                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "pessimisticStartDate":{ "type":"string", "description":"The calculated project start date that corresponds to the defined pessimistic percentile.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "optimisticDuration":{ "type":"number", "description":"The optimistic remaining duration calculated using the optimistic percentile.", "format":"double", "exampleSetFlag":false }, "pessimisticFinishDate":{ "type":"string", "description":"The calculated project finish date that corresponds to the defined pessimistic percentile.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "optimisticFinishDate":{ "type":"string", "description":"The calculated project finish date that corresponds to the defined optimistic percentile.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "removedItemType":{ "type":"string", "description":"The type of a removed item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY_UNCERTAINTY", "NONE", "RISK" ] }, "removedItemId":{ "type":"integer", "description":"The system-generated identifier of the removed risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "optimisticStartDate":{ "type":"string", "description":"The calculated project start date that corresponds to the defined optimistic percentile.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "p50Duration":{ "type":"number", "description":"The calculated median remaining duration.", "format":"double", "exampleSetFlag":false }, "p50FinishDate":{ "type":"string", "description":"The calculated project finish date that corresponds to the P50 or median percentile.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "pessimisticDuration":{ "type":"number", "description":"The pessimistic remaining duration calculated using the pessimistic percentile.", "format":"double", "exampleSetFlag":false }, "p50StartDate":{ "type":"string", "description":"The calculated project start date that corresponds to the P50 or median percentile.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "minStartDate":{ "type":"string", "description":"The earliest project start date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "maxStartDate":{ "type":"string", "description":"The latest project start date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "minFinishDate":{ "type":"string", "description":"The earliest project finish date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "maxFinishDate":{ "type":"string", "description":"The latest project finish date sampled during the risk analysis.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "minDuration":{ "type":"number", "description":"The minimum project remaining duration sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "maxDuration":{ "type":"number", "description":"The maximum project remaining duration sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "totalMeanDelay":{ "type":"number", "description":"The average project delay duration sampled during the risk analysis.
                                                                                                                                              Calculated as Mean Remaining Duration minus Project Remaining Duration.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloProjectResultFinancial":{ "title":"ApiEntityMonteCarloProjectResultFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "deterministicAtCompletionCostProbability":{ "type":"number", "description":"The probability of achieving the project deterministic at-completion cost.", "format":"double", "exampleSetFlag":false }, "totalMeanCostImpactPercent":{ "type":"number", "description":"The estimated average project cost impact before implementing a response action represented as a percent.", "format":"double", "exampleSetFlag":false }, "atCompletionCostStdDeviation":{ "type":"number", "description":"How much the distribution of sampled project costs deviates from the calculated mean project cost.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "totalAtCompletionMeanCostImpactPercent":{ "type":"number", "description":"Percentage mean cost increase of the project.", "format":"double", "exampleSetFlag":false }, "atCompletionCostVariance":{ "type":"number", "description":"The project at-completion cost variance.", "exampleSetFlag":false, "types":[ "number" ] }, "monteCarloProjectResultId":{ "type":"integer", "description":"The unique identifier of the cost of the result of a Monte Carlo project analysis.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pessimisticCostContingency":{ "type":"number", "description":"The difference between the project pessimistic remaining cost and the project deterministic remaining cost.", "format":"double", "exampleSetFlag":false }, "deterministicCostProbability":{ "type":"number", "description":"The probability of achieving the project deterministic remaining cost.", "format":"double", "exampleSetFlag":false }, "optimisticAtCompletionCost":{ "type":"number", "description":"The optimistic at-completion cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "pessimisticAtCompletionCost":{ "type":"number", "description":"The pessimistic at-completion cost calculated using the pessimistic percentile.", "format":"double", "exampleSetFlag":false }, "pessimisticAtCompletionCostContingency":{ "type":"number", "description":"The difference between the project pessimistic at-completion cost and the project deterministic at-completion cost.", "format":"double", "exampleSetFlag":false }, "totalAtCompletionMeanCostImpact":{ "type":"number", "description":"Mean cost increase of the project.", "format":"double", "exampleSetFlag":false }, "meanCost":{ "type":"number", "description":"The average project cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "costVariance":{ "type":"number", "description":"The measure of project cost performance sampled during a risk analysis. It is calculated as the difference between the project's actual cost and the planned cost.", "exampleSetFlag":false, "types":[ "number" ] }, "costStdDeviation":{ "type":"number", "description":"How much the distribution of sampled project costs deviates from the calculated mean project cost.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "meanAtCompletionCost":{ "type":"number", "description":"The average project cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "optimisticCost":{ "type":"number", "description":"The optimistic remaining cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "pessimisticCost":{ "type":"number", "description":"The pessimistic remaining cost calculated using the pessimistic percentile.", "format":"double", "exampleSetFlag":false }, "totalMeanCostImpact":{ "type":"number", "description":"The estimated average project cost impact before implementing a response action.", "format":"double", "exampleSetFlag":false }, "p50AtCompletionCost":{ "type":"number", "description":"The P50 or median at-completion cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "minimumAtCompletionCost":{ "type":"number", "description":"The minimum project at-completion cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "maximumAtCompletionCost":{ "type":"number", "description":"The maximum project at-completion cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "p50Cost":{ "type":"number", "description":"The P50 or median remaining cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "minCost":{ "type":"number", "description":"The minimum project remaining cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "maxCost":{ "type":"number", "description":"The maximum project remaining cost sampled during the risk analysis.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloRiskResult":{ "title":"ApiEntityMonteCarloRiskResult", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloRiskResultFinancial":{ "description":"An object containing Monte Carlo risk result financial fields in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityMonteCarloRiskResultFinancial" } ] }, "monteCarloRiskResultId":{ "type":"integer", "description":"The unique identifier of a risk result.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
                                                                                                                                              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                                                                                                                                              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                                                                                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "meanDelay":{ "type":"number", "description":"The estimated average project delay duration before implementing a response action.", "format":"double", "exampleSetFlag":false }, "removedItemType":{ "type":"string", "description":"The type of removed item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "0", "1", "2", "3", "4", "5" ] }, "removedItemId":{ "type":"integer", "description":"The system-generated identifier of the removed risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloRiskResultFinancial":{ "title":"ApiEntityMonteCarloRiskResultFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "monteCarloRiskResultId":{ "type":"integer", "description":"The unique identifier of a risk result.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "meanCostImpact":{ "type":"number", "description":"The estimated average project cost impact before implementing a response action.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloRunSettings":{ "title":"ApiEntityMonteCarloRunSettings", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "checkConvergenceIterationFrequency":{ "type":"integer", "description":"Number of iterations for which the mean plan finish date must remain constant for analysis results to be considered converged.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloRunSettingsId":{ "type":"integer", "description":"The unique identifier of a Monte Carlo run settings object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "includeProposedRisks":{ "type":"boolean", "description":"Controls whether the risk analysis includes risks with a status of proposed.", "exampleSetFlag":false, "types":[ "boolean" ] }, "convergedAtIterations":{ "type":"integer", "description":"The number of iterations at which the risk analysis results have converged.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "actualIterations":{ "type":"integer", "description":"Actual number of iterations the monte carlo analysis has run for a pre or post response type.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloScenario":{ "type":"string", "description":"The type of risk analysis run on a project.
                                                                                                                                              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                                                                                                                                              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                                                                                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED" ] }, "startDate":{ "type":"string", "description":"Start date of a monte carlo analysis for a pre or post response type.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"Finish date of a monte carlo analysis for a pre or post response type.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "iterations":{ "type":"integer", "description":"Number of iterations run during the risk analysis.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "optimisticPercentile":{ "type":"integer", "description":"The value (0 to 100) used to calculate optimistic percentiles in risk analysis.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "pessimisticPercentile":{ "type":"integer", "description":"The value (0 to 100) used to calculate pessimistic percentiles in risk analysis.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "randomSeed":{ "type":"integer", "description":"Number used to set the starting point for the risk analysis random number generator.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "useConvergence":{ "type":"boolean", "description":"Controls whether convergence is used to automatically determine when enough iterations have been run during risk analysis. If this option is selected, the analysis runs until specified convergence criteria are met.", "exampleSetFlag":false, "types":[ "boolean" ] }, "convergenceThreshold":{ "type":"number", "description":"Maximum percentage deviation at which analysis results are considered converged.", "format":"double", "exampleSetFlag":false }, "activitySelection":{ "type":"string", "description":"Type of activity that needs to be considered in monte carlo run . It coule take values as project only activities or mileston or level of effort activities or it could include all activites based on the value specified at the time of run for a pre or post response type.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT_ONLY", "MILESTONE_LOE", "ALL" ] }, "scheduleCost":{ "type":"boolean", "description":"Select this option to run a risk analysis where activity costs vary for each iteration. This will increase the risk analysis time. If this option is not selected, the activity costs will remain fixed for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project associated with Monte Carlo run settings.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "runTime":{ "type":"integer", "description":"Run time of a monte carlo analysis run for a pre or post response type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMonteCarloSettings":{ "title":"ApiEntityMonteCarloSettings", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "checkConvergenceIterationFrequency":{ "type":"integer", "description":"The number of iterations for which the mean plan finish date must remain constant to be considered converged.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "monteCarloSettingsId":{ "type":"integer", "description":"The unique identifier of a set of Monte Carlo settings.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "responseContext":{ "type":"string", "description":"The type of risk analysis run on a project.
                                                                                                                                              • PRE_MITIGATED : A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
                                                                                                                                              • POST_MITIGATED : A quantitative risk analysis that takes into account the impact of defined risk response plans.
                                                                                                                                              • BOTH : A quantitative risk analysis that uses both pre and post mitigated contexts.
                                                                                                                                              ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ] }, "iterations":{ "type":"integer", "description":"The number of iterations run during the risk analysis.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "includeProposedItems":{ "type":"boolean", "description":"Controls whether the risk analysis includes risks with a status of Proposed.", "exampleSetFlag":false, "types":[ "boolean" ] }, "optimisticPercentile":{ "type":"integer", "description":"The value (0% to 100%) to be used to calculate optimistic percentiles.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "pessimisticPercentile":{ "type":"integer", "description":"The value (0% to 100%) to be used to calculate pessimistic percentiles.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "randomSeed":{ "type":"integer", "description":"Defines the number to be used to set the starting point for the random number generator.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "runRiskRemovalImpact":{ "type":"boolean", "description":"Select this option to run a risk removal impact analysis on the project. A risk removal impact analysis measures and ranks the potential impact of each risk on the cost and completion date of the entire project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "useConvergence":{ "type":"boolean", "description":"Controls whether convergence is used to automatically determine when enough iterations have been run during the risk analysis. As a risk analysis is performed, the results begin to converge to such an extent that there is no point running the analysis any further because the results are only changing by a small percentage. At this point, the analysis has converged and is automatically stopped. If this option is selected, the analysis is run until the convergence criteria that have been set up are met.", "exampleSetFlag":false, "types":[ "boolean" ] }, "convergenceThreshold":{ "type":"number", "description":"The maximum percentage deviation at which analysis results are considered converged.", "format":"double", "exampleSetFlag":false }, "activitySelection":{ "type":"string", "description":"Determines the activities that are included in the risk analysis results. Selecting all the activities will increase the risk analysis time.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT_ONLY", "MILESTONE_LOE", "ALL" ] }, "scheduleCost":{ "type":"boolean", "description":"Select this option to run a risk analysis where activity costs vary for each iteration. This will increase the risk analysis time. If this option is not selected, the activity costs will remain fixed for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityNotebookTopicActivityInput":{ "title":"ApiEntityNotebookTopicActivityInput", "type":"object", "properties":{ "activityIdentifier":{ "description":"Field combinations uniquely identifying activity.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ActivityIdentifier" } ] }, "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "notes":{ "type":"string", "description":"Notes that provide additional information for the assigned business object.", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityNotebookTopicProjectInput":{ "title":"ApiEntityNotebookTopicProjectInput", "type":"object", "properties":{ "projectIdentifier":{ "description":"Field combinations uniquely identifying project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ProjectIdentifier" } ] }, "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "notes":{ "type":"string", "description":"Notes that provide additional information for the assigned business object.", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityNotebookTopicWBSInput":{ "title":"ApiEntityNotebookTopicWBSInput", "type":"object", "properties":{ "wbsIdentifier":{ "description":"Field combinations uniquely identifying WBS.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/WBSIdentifier" } ] }, "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "notes":{ "type":"string", "description":"Notes that provide additional information for the assigned business object.", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityNotebookTopicsAssignmentInput":{ "title":"ApiEntityNotebookTopicsAssignmentInput", "type":"object", "properties":{ "wbsNotes":{ "type":"array", "description":"WBS notes input for assigning notebook topics.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicWBSInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectNotes":{ "type":"array", "description":"Project notes input for assigning notebook topics.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "activityNotes":{ "type":"array", "description":"Activity notes input for assigning notebook topics.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityNotebookTopicActivityInput", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "WBSIdentifier":{ "title":"WBSIdentifier", "type":"object", "properties":{ "parentWBSCodes":{ "type":"array", "description":"The list of parent WBS codes in the hierarchy of a WBS. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs. If required, the field 'wbsPath' can be referred to get the value for the parent WBS path.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "parentId":{ "type":"integer", "description":"The system-generated identifier of the parent WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"Unique identifier of the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier for the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityNotebookTopics":{ "title":"ApiEntityNotebookTopics", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "appliesTo":{ "type":"array", "description":"Business objects to which the notebook topics apply.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "PROJECT", "WBS" ] }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                                              Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                              Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"How data is associated to this workspace.
                                                                                                                                              Owned: Data is created in this workspace.
                                                                                                                                              Inherited: Data is shared to this workspace from the parent workspace.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityNotebookTopicsInput":{ "title":"ApiEntityNotebookTopicsInput", "required":[ "notebookTopicName", "workspaceId" ], "type":"object", "properties":{ "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "appliesTo":{ "type":"array", "description":"Business objects to which the notebook topics apply.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "PROJECT", "WBS" ] }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                                              Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                              Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] } }, "description":"This entity represents a NotebookTopics object, a unique NotebookTopics object can be identified by the following combinations of the fields.
                                                                                                                                              • notebookTopicId
                                                                                                                                              • notebookTopicName,workspaceId
                                                                                                                                              • notebookTopicName,workspaceCode
                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityNotebookTopicsRemoveAppliesToInput":{ "title":"ApiEntityNotebookTopicsRemoveAppliesToInput", "required":[ "notebookTopicName", "workspaceId" ], "type":"object", "properties":{ "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "appliesTo":{ "type":"array", "description":"Business objects to which the notebook topics apply.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "PROJECT", "WBS" ] }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a NotebookTopicsRemoveAppliesTo object, a unique NotebookTopicsRemoveAppliesTo object can be identified by the following combinations of the fields.
                                                                                                                                                • notebookTopicId
                                                                                                                                                • notebookTopicName,workspaceId
                                                                                                                                                • notebookTopicName,workspaceCode
                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityExportBaselineInfoInput":{ "title":"ApiEntityExportBaselineInfoInput", "type":"object", "properties":{ "projectBaselineName":{ "maxLength":255, "type":"string", "description":"The name of a project baseline.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBaselineId":{ "type":"integer", "description":"The system-generated unique identifier of a project baseline.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityExportP6XMLInput":{ "title":"ApiEntityExportP6XMLInput", "required":[ "projectsInfo", "workspaceId" ], "type":"object", "properties":{ "projectsInfo":{ "type":"array", "description":"The projects to be exported in form of P6 XML/XER for a given workspace.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExportProjectInfoInput", "exampleSetFlag":false }, "types":[ "array" ] }, "exportCompressedFile":{ "type":"boolean", "description":"The option to download an XML/XER file or a compressed ZIP file with an XML/XER file. Default value is false.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityExportProjectInfoInput":{ "title":"ApiEntityExportProjectInfoInput", "required":[ "projectId" ], "type":"object", "properties":{ "isExportScenarioBaselineOnly":{ "type":"boolean", "description":"Flag to enable export only baselines and scenarios as a project. Default value is 'false'.", "exampleSetFlag":false, "types":[ "boolean" ] }, "baselineProjectInfo":{ "type":"array", "description":"The baselines information of the project exported in P6 XML format.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExportBaselineInfoInput", "exampleSetFlag":false }, "types":[ "array" ] }, "scenarioProjectInfo":{ "type":"array", "description":"The scenarios information of the project exported in P6 XML format.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityExportScenarioInfoInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The exported file name of the XML/XER file. It should be valid file name.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityExportScenarioInfoInput":{ "title":"ApiEntityExportScenarioInfoInput", "type":"object", "properties":{ "scenarioId":{ "type":"integer", "description":"The system-generated unique identifier of a scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "maxLength":255, "type":"string", "description":"The name of a scenario.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBaselineImportInfoInput":{ "title":"ApiEntityBaselineImportInfoInput", "type":"object", "properties":{ "existingBaselineOrScenarioId":{ "type":"integer", "description":"The system generated identifier of a baseline or scenario within a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "existingBaselineOrScenarioName":{ "type":"string", "description":"The name of the baseline or scenario of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "importType":{ "type":"string", "description":"The import type indicates the target object type.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "BASELINE", "SCENARIO", "PROJECT", "IGNORE" ] }, "importWithProject":{ "type":"boolean", "description":"Flag to enable the import baseline or scenario along with project. Default value is 'true'.", "exampleSetFlag":false, "types":[ "boolean" ] }, "existingProjectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "existingProjectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "updatedCodeOrName":{ "type":"string", "description":"The name of the baseline or scenario of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "option":{ "type":"string", "description":"The import action to be taken for each baseline or scenario in the XML or XER.", "exampleSetFlag":false, "types":[ "string" ], "default":"CREATE_NEW", "enum":[ "CREATE_NEW", "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ] } }, "exampleSetFlag":false }, "ApiEntityBaselineProjectInfoInput":{ "title":"ApiEntityBaselineProjectInfoInput", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "type":"string", "description":"The name of the baseline or scenario of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "id":{ "type":"integer", "description":"The system generated identifier of a baseline or scenario within a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "importInfo":{ "description":"The import information of specific baseline or scenario.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaselineImportInfoInput" } ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityImportClobberConfigInput":{ "title":"ApiEntityImportClobberConfigInput", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceClobberOptions":{ "type":"array", "description":"The options for taking action on workspace level items in the XML.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceClobberConfigInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectClobberOptions":{ "type":"array", "description":"The options for taking action on project level items in the XML.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectClobberConfigInput", "exampleSetFlag":false }, "types":[ "array" ] }, "scheduleOption":{ "type":"boolean", "description":"Flag to schedule the project after the import XML or XER.", "exampleSetFlag":false, "types":[ "boolean" ] }, "recalculationOption":{ "type":"boolean", "description":"Flag to recalculate assignment cost after scheduling.", "exampleSetFlag":false, "types":[ "boolean" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityImportP6XMLInput":{ "title":"ApiEntityImportP6XMLInput", "required":[ "projectsInfo", "workspaceId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectsInfo":{ "type":"array", "description":"The import option and baseline information for each project in the xml or xer file.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectInfoInput", "exampleSetFlag":false }, "types":[ "array" ] }, "importClobberConfig":{ "description":"Project & Workspace Level Objects' clobber configuration.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityImportClobberConfigInput" } ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"User provided identifier of workspace for importing xml or xer file.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"System generated identifier of workspace for importing xml or xer file.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectClobberConfigInput":{ "title":"ApiEntityProjectClobberConfigInput", "required":[ "importOption", "item" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "item":{ "type":"string", "description":"The project level entity which will be added to the application during import.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "RESOURCEROLE", "RELATIONSHIP", "WBS", "RISK", "PROJECT_CALENDAR", "PROJECTACTIVITYCODE" ] }, "importOption":{ "type":"string", "description":"The import action indicates how to handle the entities from the import file that already exist in the application.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ] }, "isDeleteUnref":{ "type":"boolean", "description":"Enables you to remove the corresponding entity from OPC if it is not part of XML or XER file being imported.", "exampleSetFlag":false, "types":[ "boolean" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectImportInfoInput":{ "title":"ApiEntityProjectImportInfoInput", "type":"object", "properties":{ "existingBaselineOrScenarioId":{ "type":"integer", "description":"The system generated identifier of a baseline or scenario within a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "existingBaselineOrScenarioName":{ "type":"string", "description":"The name of the baseline or scenario of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "importType":{ "type":"string", "description":"The import type indicates the target object type.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT", "BASELINE", "SCENARIO", "IGNORE" ] }, "existingProjectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "existingProjectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "updatedCodeOrName":{ "type":"string", "description":"The name of the baseline or scenario of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "option":{ "type":"string", "description":"The import action to be taken for each project in the XML or XER.", "exampleSetFlag":false, "types":[ "string" ], "default":"CREATE_NEW", "enum":[ "CREATE_NEW", "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ] } }, "exampleSetFlag":false }, "ApiEntityProjectInfoInput":{ "title":"ApiEntityProjectInfoInput", "required":[ "projectCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "importInfo":{ "description":"The import information of specific project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectImportInfoInput" } ] }, "baselineProjectInfo":{ "type":"array", "description":"The baselines data of specific project. It is not available for XER.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineProjectInfoInput", "exampleSetFlag":false }, "types":[ "array" ] }, "scenarioProjectInfo":{ "type":"array", "description":"The scenario data of specific project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBaselineProjectInfoInput", "exampleSetFlag":false }, "types":[ "array" ] }, "importOption":{ "maxLength":255, "type":"string", "description":"The import action to be taken for each project in the XML or XER.", "exampleSetFlag":false, "types":[ "string" ], "default":"UPDATE_EXISTING" }, "projectCode":{ "maxLength":60, "type":"string", "description":"The user provided identifier of the project being imported through XML or XER.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The system generated identifier of the project being imported through XML or XER.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceClobberConfigInput":{ "title":"ApiEntityWorkspaceClobberConfigInput", "required":[ "importOption", "item", "promoteOption" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "item":{ "type":"string", "description":"The workspace level entity which will be added to the application during import.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CALENDAR", "CURVE", "RESOURCE", "ROLE", "UNITSOFMEASURE", "ACTIVITYUDF", "ASSIGNMENTUDF", "PROJECTUDF", "WBSUDF", "RISKUDF", "ACTIVITYCODE", "PROJECTCODE", "RESOURCECODE", "NOTEBOOKTOPIC" ] }, "importOption":{ "type":"string", "description":"The import action indicates how to handle the entities from the import file that already exist in the application.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "CREATE_NEW", "UPDATE_EXISTING", "KEEP_EXISTING", "IGNORE" ] }, "isDeleteUnref":{ "type":"boolean", "description":"Enables you to remove the corresponding entity from OPC if it is not part of XML or XER file being imported.", "exampleSetFlag":false, "types":[ "boolean" ] }, "promoteOption":{ "type":"string", "description":"Promote setting for multiple matching shared data items which are found in lower-level child workspace.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "INSERT_NEW", "IGNORE", "FAIL_AND_ABORT", "NOT_APPLICABLE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityImportP6XERInput":{ "title":"ApiEntityImportP6XERInput", "required":[ "projectsInfo", "workspaceId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectsInfo":{ "type":"array", "description":"The import option and baseline information for each project in the xml or xer file.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityXerProjectInfoInput", "exampleSetFlag":false }, "types":[ "array" ] }, "importClobberConfig":{ "description":"Project & Workspace Level Objects' clobber configuration.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityImportClobberConfigInput" } ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"User provided identifier of workspace for importing xml or xer file.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"System generated identifier of workspace for importing xml or xer file.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityXerBaselineProjectInfoInput":{ "title":"ApiEntityXerBaselineProjectInfoInput", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "type":"string", "description":"The name of the baseline or scenario of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "id":{ "type":"integer", "description":"The system generated identifier of a baseline or scenario within a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityXerProjectInfoInput":{ "title":"ApiEntityXerProjectInfoInput", "required":[ "projectCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "baselineProjectInfo":{ "type":"array", "description":"The baselines data of specific project. It is not available for XER.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityXerBaselineProjectInfoInput", "exampleSetFlag":false }, "types":[ "array" ] }, "importOption":{ "maxLength":255, "type":"string", "description":"The import action to be taken for each project in the XML or XER.", "exampleSetFlag":false, "types":[ "string" ], "default":"UPDATE_EXISTING" }, "projectCode":{ "maxLength":60, "type":"string", "description":"The user provided identifier of the project being imported through XML or XER.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The system generated identifier of the project being imported through XML or XER.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPBS":{ "title":"ApiEntityPBS", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "pbsCodeHierarchy":{ "type":"array", "description":"The list of PBS codes in hierarchical way.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional details for the PBS node.", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"The sequence number of a PBS.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The name of the PBS parent of the scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pbsId":{ "type":"integer", "description":"The system-generated identifier of the PBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"A unique identifier for the PBS node.", "exampleSetFlag":false, "types":[ "string" ] }, "pbsName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the PBS node.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a PBS object, a unique PBS object can be identified by the following combinations of the fields.
                                                                                                                                                  • pbsId
                                                                                                                                                  • pbsCode,projectId
                                                                                                                                                  • pbsCode,projectCode,workspaceCode
                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityPBSInput":{ "title":"ApiEntityPBSInput", "required":[ "pbsCode", "pbsName", "projectId" ], "type":"object", "properties":{ "pbsCodeHierarchy":{ "type":"array", "description":"The list of PBS codes in hierarchical way.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional details for the PBS node.", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"The sequence number of a PBS.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The name of the PBS parent of the scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pbsId":{ "type":"integer", "description":"The system-generated identifier of the PBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"A unique identifier for the PBS node.", "exampleSetFlag":false, "types":[ "string" ] }, "pbsName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the PBS node.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a PBS object, a unique PBS object can be identified by the following combinations of the fields.
                                                                                                                                                    • pbsId
                                                                                                                                                    • pbsCode,projectId
                                                                                                                                                    • pbsCode,projectCode,workspaceCode
                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityPeriodCloseOutRecord":{ "title":"ApiEntityPeriodCloseOutRecord", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "periodCloseOutRecordId":{ "type":"integer", "description":"Unique identifier of a cost record. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodItemId":{ "type":"integer", "description":"The unique identifier of a period item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramUserPermissionsResponse":{ "title":"ApiEntityProgramUserPermissionsResponse", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"Profiles response with individual message and statusCodes.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfileResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProgramProfileInput":{ "title":"ApiEntityProgramProfileInput", "type":"object", "properties":{ "fileProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the document profile.", "exampleSetFlag":false, "types":[ "string" ] }, "reportProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the report profile.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the custom log profile.", "exampleSetFlag":false, "types":[ "string" ] }, "programProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the program profile.", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramUserPermissions":{ "title":"ApiEntityProgramUserPermissions", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueProgram":{ "title":"ApiEntityCodeValueProgram", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueObjectId":{ "type":"integer", "description":"The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The ID for the code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramConfiguredFieldValue":{ "title":"ApiEntityProgramConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFieldObjectId":{ "type":"integer", "description":"The unique identifier for the Program Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The system-generated identifier of a Program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramFinancial":{ "title":"ApiEntityProgramFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "actualCapitalCostUndistributedWorkspace1":{ "type":"number", "description":"The capital amount of actual expense cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUndistributedWorkspace1":{ "type":"number", "description":"The capital amount of actual capital cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUndistributedWorkspace2":{ "type":"number", "description":"The capital amount of actual expense cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUndistributedWorkspace2":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUndistributedWorkspace3":{ "type":"number", "description":"The capital amount of actual expense cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUndistributedWorkspace3":{ "type":"number", "description":"The capital amount of actual capital cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedWorkspace1":{ "type":"number", "description":"The capital amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedWorkspace2":{ "type":"number", "description":"The capital amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedWorkspace3":{ "type":"number", "description":"The capital amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUndistributedWorkspace1":{ "type":"number", "description":"The capital amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUndistributedWorkspace2":{ "type":"number", "description":"The capital amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUndistributedWorkspace3":{ "type":"number", "description":"The capital amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedWorkspace1":{ "type":"number", "description":"The expense amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedWorkspace2":{ "type":"number", "description":"The expense amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedWorkspace3":{ "type":"number", "description":"The expense amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUndistributedWorkspace1":{ "type":"number", "description":"The expense amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUndistributedWorkspace2":{ "type":"number", "description":"The expense amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUndistributedWorkspace3":{ "type":"number", "description":"The expense amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program planned budget.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program planned budget.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program planned budget.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of forecast cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of forecast cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of forecast cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency. ", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUndistributedWorkspace1":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUndistributedWorkspace2":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUndistributedWorkspace3":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency. ", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedWorkspace1":{ "type":"number", "description":"The expense amount of forecast cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedWorkspace2":{ "type":"number", "description":"The expense amount of forecast cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedWorkspace3":{ "type":"number", "description":"The expense amount of forecast cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUndistributedWorkspace1":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUndistributedWorkspace2":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUndistributedWorkspace3":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace2":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace3":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of actual expense cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of actual capital cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostDistributedWorkspace1":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostUndistributedWorkspace1":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of actual expense cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of actual capital cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualCostDistributedWorkspace2":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostUndistributedWorkspace2":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of actual expense cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of actual capital cost allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCostDistributedWorkspace3":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostUndistributedWorkspace3":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace1":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace2":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace3":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace1":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace2":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace3":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace1":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace2":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace3":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace3 currency. ", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace1":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace2":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace3":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedWorkspace1":{ "type":"number", "description":"The amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedWorkspace2":{ "type":"number", "description":"The amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedWorkspace3":{ "type":"number", "description":"The amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedWorkspace1":{ "type":"number", "description":"The amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedWorkspace2":{ "type":"number", "description":"The amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedWorkspace3":{ "type":"number", "description":"The amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedWorkspace1":{ "type":"number", "description":"The amount of forecast cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedWorkspace2":{ "type":"number", "description":"The amount of forecast cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedWorkspace3":{ "type":"number", "description":"The amount of forecast cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedWorkspace1":{ "type":"number", "description":"The amount of forecast cost currently unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedWorkspace2":{ "type":"number", "description":"The amount of forecast cost currently unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedWorkspace3":{ "type":"number", "description":"The amount of forecast cost currently unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostWorkspace1":{ "type":"number", "description":"The value of work performed on a program in reference to the approved budget for the program.
                                                                                                                                                      The cost value used for the Earned Value Management of a program.
                                                                                                                                                      Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostWorkspace2":{ "type":"number", "description":"The value of work performed on a program in reference to the approved budget for the program.
                                                                                                                                                      The cost value used for the Earned Value Management of a program.
                                                                                                                                                      Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostWorkspace3":{ "type":"number", "description":"The value of work performed on a program in reference to the approved budget for the program.
                                                                                                                                                      The cost value used for the Earned Value Management of a program.
                                                                                                                                                      Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostWorkspace1":{ "type":"number", "description":"The expected total cost of the program when the defined scope of work will be completed.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostWorkspace2":{ "type":"number", "description":"The expected total cost of the program when the defined scope of work will be completed.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostWorkspace3":{ "type":"number", "description":"The expected total cost of the program when the defined scope of work will be completed.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostWorkspace1":{ "type":"number", "description":"The estimated cost needed to complete the program.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostWorkspace2":{ "type":"number", "description":"The estimated cost needed to complete the program.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostWorkspace3":{ "type":"number", "description":"The estimated cost needed to complete the program.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostWorkspace1":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a program.
                                                                                                                                                      Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostWorkspace2":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a program.
                                                                                                                                                      Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostWorkspace3":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a program.
                                                                                                                                                      Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceWorkspace1":{ "type":"number", "description":"The measure of schedule performance on a program.
                                                                                                                                                      A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceWorkspace2":{ "type":"number", "description":"The measure of schedule performance on a program.
                                                                                                                                                      A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceWorkspace3":{ "type":"number", "description":"The measure of schedule performance on a program.
                                                                                                                                                      A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "netPresentValueWorkspace1":{ "type":"number", "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
                                                                                                                                                      The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                      A positive NPV is an indicator of programs that should be pursued.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "netPresentValueWorkspace2":{ "type":"number", "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
                                                                                                                                                      The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                      A positive NPV is an indicator of programs that should be pursued.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "netPresentValueWorkspace3":{ "type":"number", "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
                                                                                                                                                      The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                      A positive NPV is an indicator of programs that should be pursued.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedWorkspace1":{ "type":"number", "description":"The amount of benefits currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedWorkspace2":{ "type":"number", "description":"The amount of benefits currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedWorkspace3":{ "type":"number", "description":"The amount of benefits currently allocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedWorkspace1":{ "type":"number", "description":"The amount of benefits currently unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedWorkspace2":{ "type":"number", "description":"The amount of benefits currently unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedWorkspace3":{ "type":"number", "description":"The amount of benefits currently unallocated across the program timescale.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the 2 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace1":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace2":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace3":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostWorkspace1":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostWorkspace2":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostWorkspace3":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostWorkspace1":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostWorkspace2":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostWorkspace3":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace1":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace1":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace2":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace3":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace1":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace2":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace3":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace1":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace2":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace3":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "costVarianceWorkspace1":{ "type":"number", "description":"The measure of cost performance on a program.
                                                                                                                                                      A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "costVarianceWorkspace2":{ "type":"number", "description":"The measure of cost performance on a program.
                                                                                                                                                      A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "costVarianceWorkspace3":{ "type":"number", "description":"The measure of cost performance on a program.
                                                                                                                                                      A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                      This value can be entered manually or can be imported.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace1":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace2":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace3":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace1":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace2":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace3":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributed":{ "type":"number", "description":"The capital amount of actual expense cost allocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributed":{ "type":"number", "description":"The capital amount of actual capital cost allocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUndistributed":{ "type":"number", "description":"The capital amount of actual expense cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUndistributed":{ "type":"number", "description":"The capital amount of actual capital cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributed":{ "type":"number", "description":"The amount of planned budget allocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributed":{ "type":"number", "description":"The amount of planned budget unallocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValue":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributed":{ "type":"number", "description":"The amount of forecast cost unallocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValue":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program forecast. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUndistributed":{ "type":"number", "description":"The capital amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValue":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUndistributed":{ "type":"number", "description":"The expense amount of planned budget unallocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValue":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program planned budget.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                      Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributed":{ "type":"number", "description":"The capital amount of forecast cost allocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUndistributed":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValue":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributed":{ "type":"number", "description":"The expense amount of forecast cost allocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUndistributed":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValue":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValue":{ "type":"number", "description":"The capital present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValue":{ "type":"number", "description":"The expense present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                      Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributed":{ "type":"number", "description":"The capital amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributed":{ "type":"number", "description":"The expense amount of planned budget allocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "benefits":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.", "format":"double", "exampleSetFlag":false }, "spendForecastVar":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.", "format":"double", "exampleSetFlag":false }, "spendPlannedVariance":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.", "format":"double", "exampleSetFlag":false }, "ytdSpendCost":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.", "format":"double", "exampleSetFlag":false }, "spendCapitalCost":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendExpenseCost":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "costVariance":{ "type":"number", "description":"The measure of cost performance on a program.
                                                                                                                                                      A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "forecastCost":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.", "format":"double", "exampleSetFlag":false }, "plannedBudget":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCost":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.", "format":"double", "exampleSetFlag":false }, "spendCost":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCost":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCost":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapital":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpense":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedValueCost":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a program.
                                                                                                                                                      Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "earnedValueCost":{ "type":"number", "description":"The value of work performed on a program in reference to the approved budget for the program.
                                                                                                                                                      The cost value used for the Earned Value Management of a program.
                                                                                                                                                      Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "actualCostDistributed":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostUndistributed":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributed":{ "type":"number", "description":"The amount of forecast cost currently allocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValue":{ "type":"number", "description":"The present value, also known as discounted value, of the overall program actuals. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCost":{ "type":"number", "description":"The expected total cost of the program when the defined scope of work will be completed.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "estToCompleteCost":{ "type":"number", "description":"The estimated cost needed to complete the program.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "scheduleVariance":{ "type":"number", "description":"The measure of schedule performance on a program.
                                                                                                                                                      A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "netPresentValue":{ "type":"number", "description":"The difference between the present value (PV) of the future cash flows from current investments and program costs.
                                                                                                                                                      The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                      Positive Net Present Value (NPV) is an indicator of programs that should be pursued.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "benefitsDistributed":{ "type":"number", "description":"The amount of benefits currently allocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributed":{ "type":"number", "description":"The amount of benefits that have not been allocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValue":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.", "format":"double", "exampleSetFlag":false }, "costPerfIndex":{ "type":"number", "description":"The measure of a program's cost efficiency.
                                                                                                                                                      A value of less than 1 indicates the program is over budget, while a value greater than 1 indicates the program is under budget.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "schedPerfIndex":{ "type":"number", "description":"The measure of the work accomplished as a percentage of the work scheduled on a program.
                                                                                                                                                      Schedule Performance Index indicates whether you are meeting earned and planned values within your program schedule.
                                                                                                                                                      A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the program is ahead of schedule.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "paybackPeriod":{ "type":"number", "description":"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 program.


                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "profitabilityIndex":{ "type":"number", "description":"The index based on the value of a program's present values divided by initial program investments.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "returnOnInvestment":{ "type":"number", "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a program or portfolio.
                                                                                                                                                      For example, a program is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "plannedBudgetOutOfSync":{ "type":"boolean", "description":"Indicates whether the Planned Budget roll-up from projects is out of sync.", "exampleSetFlag":false, "types":[ "boolean" ] }, "forecastOutOfSync":{ "type":"boolean", "description":"Indicates whether the Forecast roll-up from projects is out of sync.", "exampleSetFlag":false, "types":[ "boolean" ] }, "spendsOutOfSync":{ "type":"boolean", "description":"Indicates whether the Actuals roll-up from projects is out of sync.", "exampleSetFlag":false, "types":[ "boolean" ] }, "benefitsOutOfSync":{ "type":"boolean", "description":"Indicates whether the Benefits roll-up from projects is out of sync.", "exampleSetFlag":false, "types":[ "boolean" ] }, "annualDiscountRate":{ "maximum":1, "minimum":0, "type":"number", "description":"The interest rate associated with the cost of an investment from your commercial bank or another funding source.
                                                                                                                                                      For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "intRateOfReturn":{ "type":"number", "description":"The quantitative measurement used to compare the profitability of program investments.
                                                                                                                                                      The rate at which investors will receive returns on their investments in a program.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "programId":{ "type":"integer", "description":"The unique identifier for a program set by the user who created the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramLinkedObject":{ "title":"ApiEntityProgramLinkedObject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "objectType":{ "maxLength":255, "type":"string", "description":"The type of linked object.", "exampleSetFlag":false, "types":[ "string" ] }, "objectId":{ "type":"integer", "description":"The system-generated identifier of a program linked object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramPhaseFinancial":{ "title":"ApiEntityProgramPhaseFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "yearEndForecastCostWorkspace2":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace3":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace1":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace2":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace3":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace1":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace2":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace3":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace1":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace2":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace3":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace3 currency. ", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace1":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace2":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace3":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace1":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace2":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace3":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostWorkspace1":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostWorkspace2":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostWorkspace3":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostWorkspace1":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostWorkspace2":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostWorkspace3":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace1":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace1":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace2":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace3":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace1":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace2":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace3":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace1":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace2":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace3":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace1":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace2":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace3":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace1":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                      This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace2":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                      This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace3":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                      This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "year":{ "type":"integer", "description":"The time period during which budget planning for the program takes place in years.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "month":{ "type":"integer", "description":"The time period during which budget planning for the program takes place in months.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "programPhaseFinancialId":{ "type":"integer", "description":"The system-generated identifier of a progam phase financial.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "benefits":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.", "format":"double", "exampleSetFlag":false }, "spendForecastVar":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.", "format":"double", "exampleSetFlag":false }, "spendPlannedVariance":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.", "format":"double", "exampleSetFlag":false }, "ytdSpendCost":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                      YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.", "format":"double", "exampleSetFlag":false }, "spendCapitalCost":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendExpenseCost":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "phaseStartDate":{ "type":"string", "description":"The starting date for a time phase of the program life cycle.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastCost":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.", "format":"double", "exampleSetFlag":false }, "plannedBudget":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCost":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.", "format":"double", "exampleSetFlag":false }, "spendCost":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                      Actuals cannot be edited if a program has a status of Proposal.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCost":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCost":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                      Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapital":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                      Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpense":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                      This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "programId":{ "type":"integer", "description":"The unique identifier for a program set by the user who created the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramResponse":{ "title":"ApiEntityProgramResponse", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "breakdownCapitalForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "programFinancial":{ "description":"The financial fields associated with a program.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramFinancial" } ] }, "programSettings":{ "type":"array", "description":"The program settings associated with the program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "programPhaseFinancials":{ "type":"array", "description":"The program cashflow data associated with the program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramPhaseFinancial", "exampleSetFlag":false }, "types":[ "array" ] }, "owner":{ "maxLength":255, "type":"string", "description":"The manager or person responsible for the program.", "exampleSetFlag":false, "types":[ "string" ] }, "lastProgramEvaluationDate":{ "type":"string", "description":"The most recent evaluation date for the program.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"The detailed summary for the program. 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.", "exampleSetFlag":false, "types":[ "string" ] }, "statusDate":{ "type":"string", "description":"The date and time the program status was changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedStart":{ "type":"string", "description":"The start date for the time phased Planned Budget of the program.
                                                                                                                                                      Planned Budget cost spread will adjust when this date is changed.
                                                                                                                                                      The Program Planned Start also represents the earliest date that activities can occur within a program schedule.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The finish date for the time phased Planned Budget of the program.
                                                                                                                                                      Planned Budget cost spread will adjust when this date is changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The Actual Start indicates the date work on the program began.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The Actual Finish displays the date on which a program is considered complete.
                                                                                                                                                      This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastFinishDate":{ "type":"string", "description":"The planned finish date of a program's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastStartDate":{ "type":"string", "description":"The planned start date of a program's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendStartDate":{ "type":"string", "description":"The start date for the program actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendFinishDate":{ "type":"string", "description":"The finish date for the program actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsStartDate":{ "type":"string", "description":"The date benefits on the program began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsFinishDate":{ "type":"string", "description":"The date benefits on the program finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationScore":{ "type":"number", "description":"The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.", "format":"double", "exampleSetFlag":false }, "spendEffectiveDate":{ "type":"string", "description":"The month in which an actuals value was last added to the program ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastToSpend":{ "type":"boolean", "description":"Enables you to link program Forecast data to program Actuals data.
                                                                                                                                                      When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualsLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the actuals curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "forecastLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the forecast curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedBudgetLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the planned budget curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the benefit curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "linkedObjects":{ "type":"array", "description":"The list of projects linked to the program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramLinkedObject", "exampleSetFlag":false }, "types":[ "array" ] }, "programName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the program.", "exampleSetFlag":false, "types":[ "string" ] }, "problemOrOpportunity":{ "maxLength":4000, "type":"string", "description":"A detailed description of the problem or opportunity the program addresses.", "exampleSetFlag":false, "types":[ "string" ] }, "businessImpact":{ "maxLength":4000, "type":"string", "description":"A detailed description of the business impact of the program.", "exampleSetFlag":false, "types":[ "string" ] }, "strategicObjective":{ "maxLength":4000, "type":"string", "description":"A detailed description of the strategic object of the program.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMatrixId":{ "type":"integer", "description":"The risk matrix assigned to the program for calculating program risk scores.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "evaluationMatrixId":{ "type":"integer", "description":"The unique identifier for the program evaluation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "updateUser":{ "maxLength":255, "type":"string", "description":"The user who last modified the program", "exampleSetFlag":false, "types":[ "string" ] }, "createDate":{ "type":"string", "description":"The date the program was added.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "createUser":{ "maxLength":255, "type":"string", "description":"The user who added the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The current status of the program.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PLANNED", "ACTIVE", "INACTIVE", "ON_HOLD", "COMPLETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramSetting":{ "title":"ApiEntityProgramSetting", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "settingName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a program setting.", "exampleSetFlag":false, "types":[ "string" ] }, "settingValue":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Value of a program setting.", "exampleSetFlag":false, "types":[ "string" ] }, "programSettingId":{ "type":"integer", "description":"The unique identifier of a program setting. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The unique identifier of a program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueProgramInput":{ "title":"ApiEntityCodeValueProgramInput", "required":[ "codeTypeId", "codeValueCode", "codeValueName" ], "type":"object", "properties":{ "codeValueObjectId":{ "type":"integer", "description":"The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The ID for the code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueProgram object, a unique CodeValueProgram object can be identified by the following combinations of the fields.
                                                                                                                                                      • codeValueObjectId
                                                                                                                                                      • codeTypeCode,codeValueCode
                                                                                                                                                      • codeTypeId,codeValueCode
                                                                                                                                                      • codeValueId
                                                                                                                                                      • codeValueCode,codeTypeCode,parentId
                                                                                                                                                      • codeValueCode,codeTypeId,parentId
                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityProgramConfiguredFieldValueInput":{ "title":"ApiEntityProgramConfiguredFieldValueInput", "type":"object", "properties":{ "configuredFieldObjectId":{ "type":"integer", "description":"The unique identifier for the Program Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The system-generated identifier of a Program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProgramConfiguredFieldValue object, a unique ProgramConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                        • configuredFieldObjectId
                                                                                                                                                        • columnDefinitionId
                                                                                                                                                        • columnName
                                                                                                                                                        • columnLabel
                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityProgramFinancialInput":{ "title":"ApiEntityProgramFinancialInput", "type":"object", "properties":{ "plannedBudgetCOR":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                          Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "forecastCostCOR":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                          Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "spendCostCOR":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                          Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "costVarianceCOR":{ "type":"number", "description":"The measure of cost performance on a program.
                                                                                                                                                          A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                          This value can be entered manually or can be imported.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "earnedValueCostCOR":{ "type":"number", "description":"The value of work performed on a program in reference to the approved budget for the program.
                                                                                                                                                          The cost value used for the Earned Value Management of a program.
                                                                                                                                                          Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
                                                                                                                                                          This value can be entered manually or can be imported.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostCOR":{ "type":"number", "description":"The expected total cost of the program when the defined scope of work will be completed.
                                                                                                                                                          This value can be entered manually or can be imported.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostCOR":{ "type":"number", "description":"The estimated cost needed to complete the program.
                                                                                                                                                          This value can be entered manually or can be imported.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "plannedValueCostCOR":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a program.
                                                                                                                                                          Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                          This value can be entered manually or can be imported.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceCOR":{ "type":"number", "description":"The measure of schedule performance on a program.
                                                                                                                                                          A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                          This value can be entered manually or can be imported.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "netPresentValueCOR":{ "type":"number", "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
                                                                                                                                                          The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                          A positive NPV is an indicator of programs that should be pursued.
                                                                                                                                                          This value can be entered manually or can be imported.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "benefitsCOR":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalCOR":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                          Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseCOR":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostCOR":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                          Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostCOR":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                          Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostCOR":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                          Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostCOR":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                          Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                          This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "costPerfIndex":{ "type":"number", "description":"The measure of a program's cost efficiency.
                                                                                                                                                          A value of less than 1 indicates the program is over budget, while a value greater than 1 indicates the program is under budget.
                                                                                                                                                          This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "schedPerfIndex":{ "type":"number", "description":"The measure of the work accomplished as a percentage of the work scheduled on a program.
                                                                                                                                                          Schedule Performance Index indicates whether you are meeting earned and planned values within your program schedule.
                                                                                                                                                          A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the program is ahead of schedule.
                                                                                                                                                          This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "paybackPeriod":{ "type":"number", "description":"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 program.


                                                                                                                                                          This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "profitabilityIndex":{ "type":"number", "description":"The index based on the value of a program's present values divided by initial program investments.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "returnOnInvestment":{ "type":"number", "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a program or portfolio.
                                                                                                                                                          For example, a program is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%.
                                                                                                                                                          This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "annualDiscountRate":{ "maximum":1, "minimum":0, "type":"number", "description":"The interest rate associated with the cost of an investment from your commercial bank or another funding source.
                                                                                                                                                          For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value.
                                                                                                                                                          This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "intRateOfReturn":{ "type":"number", "description":"The quantitative measurement used to compare the profitability of program investments.
                                                                                                                                                          The rate at which investors will receive returns on their investments in a program.
                                                                                                                                                          This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "programId":{ "type":"integer", "description":"The unique identifier for a program set by the user who created the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProgramInput":{ "title":"ApiEntityProgramInput", "required":[ "programName", "workspaceId" ], "type":"object", "properties":{ "owner":{ "maxLength":255, "type":"string", "description":"The manager or person responsible for the program.", "exampleSetFlag":false, "types":[ "string" ] }, "breakdownCapitalForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "programFinancial":{ "description":"The financial fields associated with a program.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramFinancialInput" } ] }, "description":{ "maxLength":4000, "type":"string", "description":"The detailed summary for the program. 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.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedStart":{ "type":"string", "description":"The start date for the time phased Planned Budget of the program.
                                                                                                                                                          Planned Budget cost spread will adjust when this date is changed.
                                                                                                                                                          The Program Planned Start also represents the earliest date that activities can occur within a program schedule.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The finish date for the time phased Planned Budget of the program.
                                                                                                                                                          Planned Budget cost spread will adjust when this date is changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The Actual Start indicates the date work on the program began.
                                                                                                                                                          This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The Actual Finish displays the date on which a program is considered complete.
                                                                                                                                                          This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastFinishDate":{ "type":"string", "description":"The planned finish date of a program's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastStartDate":{ "type":"string", "description":"The planned start date of a program's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendStartDate":{ "type":"string", "description":"The start date for the program actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendFinishDate":{ "type":"string", "description":"The finish date for the program actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsStartDate":{ "type":"string", "description":"The date benefits on the program began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsFinishDate":{ "type":"string", "description":"The date benefits on the program finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendEffectiveDate":{ "type":"string", "description":"The month in which an actuals value was last added to the program ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastToSpend":{ "type":"boolean", "description":"Enables you to link program Forecast data to program Actuals data.
                                                                                                                                                          When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualsLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the actuals curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "forecastLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the forecast curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedBudgetLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the planned budget curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the benefit curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "linkedObjects":{ "type":"array", "description":"The list of projects linked to the program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramLinkedObjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programName":{ "maxLength":255, "type":"string", "description":"The name of the program.", "exampleSetFlag":false, "types":[ "string" ] }, "problemOrOpportunity":{ "maxLength":4000, "type":"string", "description":"A detailed description of the problem or opportunity the program addresses.", "exampleSetFlag":false, "types":[ "string" ] }, "businessImpact":{ "maxLength":4000, "type":"string", "description":"A detailed description of the business impact of the program.", "exampleSetFlag":false, "types":[ "string" ] }, "strategicObjective":{ "maxLength":4000, "type":"string", "description":"A detailed description of the strategic object of the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programSettings":{ "type":"array", "description":"The program settings associated with the program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramSettingInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programPhaseFinancials":{ "type":"array", "description":"The program cashflow data associated with the program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramPhaseFinancialInput", "exampleSetFlag":false }, "types":[ "array" ] }, "riskMatrixId":{ "type":"integer", "description":"The risk matrix assigned to the program for calculating program risk scores.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProgramInput", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The current status of the program.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PLANNED", "ACTIVE", "INACTIVE", "ON_HOLD", "COMPLETE" ] } }, "description":"This entity represents a Program object, a unique Program object can be identified by the following combinations of the fields.
                                                                                                                                                          • programId
                                                                                                                                                          • programCode,workspaceId
                                                                                                                                                          • programCode,workspaceCode
                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityProgramLinkedObjectInput":{ "title":"ApiEntityProgramLinkedObjectInput", "type":"object", "properties":{ "objectType":{ "maxLength":255, "type":"string", "description":"The type of linked object.", "exampleSetFlag":false, "types":[ "string" ] }, "objectId":{ "type":"integer", "description":"The system-generated identifier of a program linked object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProgramLinkedObject object, a unique ProgramLinkedObject object can be identified by the following combinations of the fields.
                                                                                                                                                            • objectId,objectType
                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityProgramPhaseFinancialInput":{ "title":"ApiEntityProgramPhaseFinancialInput", "type":"object", "properties":{ "plannedBudgetCOR":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                              Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "forecastCostCOR":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                              Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "spendCostCOR":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                              Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "benefitsCOR":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalCOR":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                              Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseCOR":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostCOR":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                              Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostCOR":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                              Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostCOR":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                              Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostCOR":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                              Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                              This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "year":{ "type":"integer", "description":"The time period during which budget planning for the program takes place in years.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "month":{ "type":"integer", "description":"The time period during which budget planning for the program takes place in months.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "programPhaseFinancialId":{ "type":"integer", "description":"The system-generated identifier of a progam phase financial.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "phaseStartDate":{ "type":"string", "description":"The starting date for a time phase of the program life cycle.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for a program set by the user who created the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProgramPhaseFinancial object, a unique ProgramPhaseFinancial object can be identified by the following combinations of the fields.
                                                                                                                                                              • programPhaseFinancialId
                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityProgramSettingInput":{ "title":"ApiEntityProgramSettingInput", "type":"object", "properties":{ "settingName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a program setting.", "exampleSetFlag":false, "types":[ "string" ] }, "settingValue":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Value of a program setting.", "exampleSetFlag":false, "types":[ "string" ] }, "programSettingId":{ "type":"integer", "description":"The unique identifier of a program setting. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The unique identifier of a program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProgram":{ "title":"ApiEntityProgram", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "owner":{ "maxLength":255, "type":"string", "description":"The manager or person responsible for the program.", "exampleSetFlag":false, "types":[ "string" ] }, "lastProgramEvaluationDate":{ "type":"string", "description":"The most recent evaluation date for the program.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "type":"string", "description":"The detailed summary for the program. 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.", "exampleSetFlag":false, "types":[ "string" ] }, "statusDate":{ "type":"string", "description":"The date and time the program status was changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedStart":{ "type":"string", "description":"The start date for the time phased Planned Budget of the program.
                                                                                                                                                                Planned Budget cost spread will adjust when this date is changed.
                                                                                                                                                                The Program Planned Start also represents the earliest date that activities can occur within a program schedule.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinish":{ "type":"string", "description":"The finish date for the time phased Planned Budget of the program.
                                                                                                                                                                Planned Budget cost spread will adjust when this date is changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The Actual Start indicates the date work on the program began.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The Actual Finish displays the date on which a program is considered complete.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastFinishDate":{ "type":"string", "description":"The planned finish date of a program's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastStartDate":{ "type":"string", "description":"The planned start date of a program's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendStartDate":{ "type":"string", "description":"The start date for the program actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendFinishDate":{ "type":"string", "description":"The finish date for the program actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsStartDate":{ "type":"string", "description":"The date benefits on the program began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsFinishDate":{ "type":"string", "description":"The date benefits on the program finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationScore":{ "type":"number", "description":"The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.", "format":"double", "exampleSetFlag":false }, "spendEffectiveDate":{ "type":"string", "description":"The month in which an actuals value was last added to the program ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastToSpend":{ "type":"boolean", "description":"Enables you to link program Forecast data to program Actuals data.
                                                                                                                                                                When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualsLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the actuals curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "forecastLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the forecast curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedBudgetLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the planned budget curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsLinkType":{ "maxLength":255, "type":"string", "description":"The field source for the benefit curve in cash flow.", "exampleSetFlag":false, "types":[ "string" ] }, "linkedObjects":{ "type":"array", "description":"The list of projects linked to the program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramLinkedObject", "exampleSetFlag":false }, "types":[ "array" ] }, "programName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the program.", "exampleSetFlag":false, "types":[ "string" ] }, "problemOrOpportunity":{ "maxLength":4000, "type":"string", "description":"A detailed description of the problem or opportunity the program addresses.", "exampleSetFlag":false, "types":[ "string" ] }, "businessImpact":{ "maxLength":4000, "type":"string", "description":"A detailed description of the business impact of the program.", "exampleSetFlag":false, "types":[ "string" ] }, "strategicObjective":{ "maxLength":4000, "type":"string", "description":"A detailed description of the strategic object of the program.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMatrixId":{ "type":"integer", "description":"The risk matrix assigned to the program for calculating program risk scores.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProgram", "exampleSetFlag":false }, "types":[ "array" ] }, "evaluationMatrixId":{ "type":"integer", "description":"The unique identifier for the program evaluation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "updateUser":{ "maxLength":255, "type":"string", "description":"The user who last modified the program", "exampleSetFlag":false, "types":[ "string" ] }, "createDate":{ "type":"string", "description":"The date the program was added.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "createUser":{ "maxLength":255, "type":"string", "description":"The user who added the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The current status of the program.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PLANNED", "ACTIVE", "INACTIVE", "ON_HOLD", "COMPLETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramFinancialAndSetting":{ "title":"ApiEntityProgramFinancialAndSetting", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "breakdownCapitalForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "programSettings":{ "type":"array", "description":"The program settings associated with the program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "programPhaseFinancials":{ "type":"array", "description":"The program cashflow data associated with the program.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramPhaseFinancial", "exampleSetFlag":false }, "types":[ "array" ] }, "actualCapitalCostUndistributedWorkspace1":{ "type":"number", "description":"The capital amount of actual expense cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUndistributedWorkspace1":{ "type":"number", "description":"The capital amount of actual capital cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUndistributedWorkspace2":{ "type":"number", "description":"The capital amount of actual expense cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUndistributedWorkspace2":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUndistributedWorkspace3":{ "type":"number", "description":"The capital amount of actual expense cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUndistributedWorkspace3":{ "type":"number", "description":"The capital amount of actual capital cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedWorkspace1":{ "type":"number", "description":"The capital amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedWorkspace2":{ "type":"number", "description":"The capital amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributedWorkspace3":{ "type":"number", "description":"The capital amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUndistributedWorkspace1":{ "type":"number", "description":"The capital amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUndistributedWorkspace2":{ "type":"number", "description":"The capital amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUndistributedWorkspace3":{ "type":"number", "description":"The capital amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedWorkspace1":{ "type":"number", "description":"The expense amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedWorkspace2":{ "type":"number", "description":"The expense amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributedWorkspace3":{ "type":"number", "description":"The expense amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUndistributedWorkspace1":{ "type":"number", "description":"The expense amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUndistributedWorkspace2":{ "type":"number", "description":"The expense amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUndistributedWorkspace3":{ "type":"number", "description":"The expense amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program planned budget.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program planned budget.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program planned budget.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of forecast cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of forecast cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of forecast cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency. ", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUndistributedWorkspace1":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUndistributedWorkspace2":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUndistributedWorkspace3":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency. ", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedWorkspace1":{ "type":"number", "description":"The expense amount of forecast cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedWorkspace2":{ "type":"number", "description":"The expense amount of forecast cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributedWorkspace3":{ "type":"number", "description":"The expense amount of forecast cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUndistributedWorkspace1":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUndistributedWorkspace2":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUndistributedWorkspace3":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace2":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace3":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace1":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace2":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendPlannedVarianceWorkspace3":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of actual expense cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedWorkspace1":{ "type":"number", "description":"The capital amount of actual capital cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostDistributedWorkspace1":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostUndistributedWorkspace1":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of actual expense cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedWorkspace2":{ "type":"number", "description":"The capital amount of actual capital cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualCostDistributedWorkspace2":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostUndistributedWorkspace2":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of actual expense cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributedWorkspace3":{ "type":"number", "description":"The capital amount of actual capital cost allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCostDistributedWorkspace3":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostUndistributedWorkspace3":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace1":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace2":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalWorkspace3":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace1":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace2":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseWorkspace3":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace1":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace2":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostWorkspace3":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the workspace3 currency. ", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace1":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace2":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostWorkspace3":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedWorkspace1":{ "type":"number", "description":"The amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedWorkspace2":{ "type":"number", "description":"The amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributedWorkspace3":{ "type":"number", "description":"The amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedWorkspace1":{ "type":"number", "description":"The amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedWorkspace2":{ "type":"number", "description":"The amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributedWorkspace3":{ "type":"number", "description":"The amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedWorkspace1":{ "type":"number", "description":"The amount of forecast cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedWorkspace2":{ "type":"number", "description":"The amount of forecast cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributedWorkspace3":{ "type":"number", "description":"The amount of forecast cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedWorkspace1":{ "type":"number", "description":"The amount of forecast cost currently unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedWorkspace2":{ "type":"number", "description":"The amount of forecast cost currently unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributedWorkspace3":{ "type":"number", "description":"The amount of forecast cost currently unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostWorkspace1":{ "type":"number", "description":"The value of work performed on a program in reference to the approved budget for the program.
                                                                                                                                                                The cost value used for the Earned Value Management of a program.
                                                                                                                                                                Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostWorkspace2":{ "type":"number", "description":"The value of work performed on a program in reference to the approved budget for the program.
                                                                                                                                                                The cost value used for the Earned Value Management of a program.
                                                                                                                                                                Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostWorkspace3":{ "type":"number", "description":"The value of work performed on a program in reference to the approved budget for the program.
                                                                                                                                                                The cost value used for the Earned Value Management of a program.
                                                                                                                                                                Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostWorkspace1":{ "type":"number", "description":"The expected total cost of the program when the defined scope of work will be completed.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostWorkspace2":{ "type":"number", "description":"The expected total cost of the program when the defined scope of work will be completed.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCostWorkspace3":{ "type":"number", "description":"The expected total cost of the program when the defined scope of work will be completed.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostWorkspace1":{ "type":"number", "description":"The estimated cost needed to complete the program.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostWorkspace2":{ "type":"number", "description":"The estimated cost needed to complete the program.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostWorkspace3":{ "type":"number", "description":"The estimated cost needed to complete the program.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostWorkspace1":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a program.
                                                                                                                                                                Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostWorkspace2":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a program.
                                                                                                                                                                Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostWorkspace3":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a program.
                                                                                                                                                                Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceWorkspace1":{ "type":"number", "description":"The measure of schedule performance on a program.
                                                                                                                                                                A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceWorkspace2":{ "type":"number", "description":"The measure of schedule performance on a program.
                                                                                                                                                                A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceWorkspace3":{ "type":"number", "description":"The measure of schedule performance on a program.
                                                                                                                                                                A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "netPresentValueWorkspace1":{ "type":"number", "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
                                                                                                                                                                The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                                A positive NPV is an indicator of programs that should be pursued.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "netPresentValueWorkspace2":{ "type":"number", "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
                                                                                                                                                                The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                                A positive NPV is an indicator of programs that should be pursued.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "netPresentValueWorkspace3":{ "type":"number", "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
                                                                                                                                                                The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                                A positive NPV is an indicator of programs that should be pursued.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedWorkspace1":{ "type":"number", "description":"The amount of benefits currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedWorkspace2":{ "type":"number", "description":"The amount of benefits currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "benefitsDistributedWorkspace3":{ "type":"number", "description":"The amount of benefits currently allocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedWorkspace1":{ "type":"number", "description":"The amount of benefits currently unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedWorkspace2":{ "type":"number", "description":"The amount of benefits currently unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributedWorkspace3":{ "type":"number", "description":"The amount of benefits currently unallocated across the program timescale.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueWorkspace1":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueWorkspace2":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValueWorkspace3":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueWorkspace1":{ "type":"number", "description":"The capital present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueWorkspace2":{ "type":"number", "description":"The capital present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the 2 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValueWorkspace3":{ "type":"number", "description":"The capital present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueWorkspace1":{ "type":"number", "description":"The expense present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueWorkspace2":{ "type":"number", "description":"The expense present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValueWorkspace3":{ "type":"number", "description":"The expense present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace1":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace2":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendForecastVarWorkspace3":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostWorkspace1":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostWorkspace2":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendCapitalCostWorkspace3":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostWorkspace1":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostWorkspace2":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendExpenseCostWorkspace3":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCostWorkspace1":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace1":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                                YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace2":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                                YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "ytdSpendCostWorkspace3":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                                YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace1":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace2":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetWorkspace3":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace1":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace2":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "forecastCostWorkspace3":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "costVarianceWorkspace1":{ "type":"number", "description":"The measure of cost performance on a program.
                                                                                                                                                                A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "costVarianceWorkspace2":{ "type":"number", "description":"The measure of cost performance on a program.
                                                                                                                                                                A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "costVarianceWorkspace3":{ "type":"number", "description":"The measure of cost performance on a program.
                                                                                                                                                                A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                                This value can be entered manually or can be imported.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace1":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace2":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "spendCostWorkspace3":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace1":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                                This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace2":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                                This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "benefitsWorkspace3":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
                                                                                                                                                                This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostDistributed":{ "type":"number", "description":"The capital amount of actual expense cost allocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostDistributed":{ "type":"number", "description":"The capital amount of actual capital cost allocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostUndistributed":{ "type":"number", "description":"The capital amount of actual expense cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostUndistributed":{ "type":"number", "description":"The capital amount of actual capital cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributed":{ "type":"number", "description":"The amount of planned budget allocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributed":{ "type":"number", "description":"The amount of planned budget unallocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "plannedBudgetPresentValue":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributed":{ "type":"number", "description":"The amount of forecast cost unallocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "forecastCostPresentValue":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program forecast. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalUndistributed":{ "type":"number", "description":"The capital amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalPresentValue":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseUndistributed":{ "type":"number", "description":"The expense amount of planned budget unallocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpensePresentValue":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program planned budget.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate.
                                                                                                                                                                Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostDistributed":{ "type":"number", "description":"The capital amount of forecast cost allocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostUndistributed":{ "type":"number", "description":"The capital amount of forecast cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostPresentValue":{ "type":"number", "description":"The capital present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostDistributed":{ "type":"number", "description":"The expense amount of forecast cost allocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostUndistributed":{ "type":"number", "description":"The expense amount of forecast cost unallocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostPresentValue":{ "type":"number", "description":"The expense present value, also known as the discounted value, of the overall program forecast.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostPresentValue":{ "type":"number", "description":"The capital present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostPresentValue":{ "type":"number", "description":"The expense present value, also known as discounted value, of the overall program actuals.
                                                                                                                                                                Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalDistributed":{ "type":"number", "description":"The capital amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseDistributed":{ "type":"number", "description":"The expense amount of planned budget allocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "benefits":{ "type":"number", "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.", "format":"double", "exampleSetFlag":false }, "spendForecastVar":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Forecast.", "format":"double", "exampleSetFlag":false }, "spendPlannedVariance":{ "type":"number", "description":"The total and time phased variance between the program's Actuals and Planned Budget.", "format":"double", "exampleSetFlag":false }, "ytdSpendCost":{ "type":"number", "description":"A measurement of capital spent on a program starting from the beginning of the year up to the present date.
                                                                                                                                                                YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.", "format":"double", "exampleSetFlag":false }, "spendCapitalCost":{ "type":"number", "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendExpenseCost":{ "type":"number", "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "costVariance":{ "type":"number", "description":"The measure of cost performance on a program.
                                                                                                                                                                A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "forecastCost":{ "type":"number", "description":"The total estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.", "format":"double", "exampleSetFlag":false }, "plannedBudget":{ "type":"number", "description":"The planned total cost of a program as defined by the program manager.
                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCost":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.", "format":"double", "exampleSetFlag":false }, "spendCost":{ "type":"number", "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                Actuals cannot be edited if a program has a status of Proposal.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCost":{ "type":"number", "description":"The total capital estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCost":{ "type":"number", "description":"The total expense estimation of a program's remaining costs.
                                                                                                                                                                Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapital":{ "type":"number", "description":"The planned total capital cost of a program as defined by the program manager.
                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpense":{ "type":"number", "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedValueCost":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a program.
                                                                                                                                                                Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "earnedValueCost":{ "type":"number", "description":"The value of work performed on a program in reference to the approved budget for the program.
                                                                                                                                                                The cost value used for the Earned Value Management of a program.
                                                                                                                                                                Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "actualCostDistributed":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostUndistributed":{ "type":"number", "description":"The amount of actual cost currently allocated across the program timescale.
                                                                                                                                                                This value is based on the base currency with specified exchange rate.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributed":{ "type":"number", "description":"The amount of forecast cost currently allocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "actualCostPresentValue":{ "type":"number", "description":"The present value, also known as discounted value, of the overall program actuals. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCost":{ "type":"number", "description":"The expected total cost of the program when the defined scope of work will be completed.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "estToCompleteCost":{ "type":"number", "description":"The estimated cost needed to complete the program.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "scheduleVariance":{ "type":"number", "description":"The measure of schedule performance on a program.
                                                                                                                                                                A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "netPresentValue":{ "type":"number", "description":"The difference between the present value (PV) of the future cash flows from current investments and program costs.
                                                                                                                                                                The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                                Positive Net Present Value (NPV) is an indicator of programs that should be pursued.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "benefitsDistributed":{ "type":"number", "description":"The amount of benefits currently allocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "benefitsUndistributed":{ "type":"number", "description":"The amount of benefits that have not been allocated across the program timescale.", "format":"double", "exampleSetFlag":false }, "benefitsPresentValue":{ "type":"number", "description":"The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.", "format":"double", "exampleSetFlag":false }, "costPerfIndex":{ "type":"number", "description":"The measure of a program's cost efficiency.
                                                                                                                                                                A value of less than 1 indicates the program is over budget, while a value greater than 1 indicates the program is under budget.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "schedPerfIndex":{ "type":"number", "description":"The measure of the work accomplished as a percentage of the work scheduled on a program.
                                                                                                                                                                Schedule Performance Index indicates whether you are meeting earned and planned values within your program schedule.
                                                                                                                                                                A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the program is ahead of schedule.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "paybackPeriod":{ "type":"number", "description":"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 program.


                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "profitabilityIndex":{ "type":"number", "description":"The index based on the value of a program's present values divided by initial program investments.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "returnOnInvestment":{ "type":"number", "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a program or portfolio.
                                                                                                                                                                For example, a program is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "plannedBudgetOutOfSync":{ "type":"boolean", "description":"Indicates whether the Planned Budget roll-up from projects is out of sync.", "exampleSetFlag":false, "types":[ "boolean" ] }, "forecastOutOfSync":{ "type":"boolean", "description":"Indicates whether the Forecast roll-up from projects is out of sync.", "exampleSetFlag":false, "types":[ "boolean" ] }, "spendsOutOfSync":{ "type":"boolean", "description":"Indicates whether the Actuals roll-up from projects is out of sync.", "exampleSetFlag":false, "types":[ "boolean" ] }, "benefitsOutOfSync":{ "type":"boolean", "description":"Indicates whether the Benefits roll-up from projects is out of sync.", "exampleSetFlag":false, "types":[ "boolean" ] }, "annualDiscountRate":{ "maximum":1, "minimum":0, "type":"number", "description":"The interest rate associated with the cost of an investment from your commercial bank or another funding source.
                                                                                                                                                                For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "intRateOfReturn":{ "type":"number", "description":"The quantitative measurement used to compare the profitability of program investments.
                                                                                                                                                                The rate at which investors will receive returns on their investments in a program.
                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "programId":{ "type":"integer", "description":"The unique identifier for a program set by the user who created the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveProgramUserPermissionsResponse":{ "title":"ApiEntityRemoveProgramUserPermissionsResponse", "type":"object", "properties":{ "message":{ "type":"string", "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveProgramUserPermissions":{ "title":"ApiEntityRemoveProgramUserPermissions", "type":"object", "properties":{ "userNames":{ "type":"array", "description":"List of user names for removing users.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudget":{ "title":"ApiEntityProgramBudget", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "withdrawApprovalByUserId":{ "type":"integer", "description":"The user who withdrew the approved budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "withdrawApprovalByUserName":{ "maxLength":255, "type":"string", "description":"The The username of the user who withdrew the approved budget.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "submitByUserName":{ "maxLength":255, "type":"string", "description":"The username of the user who submitted the budget for review.", "exampleSetFlag":false, "types":[ "string" ] }, "submitDate":{ "type":"string", "description":"The date the budget was submitted for review.", "format":"date-time", "exampleSetFlag":false }, "withdrawApprovalDate":{ "type":"string", "description":"The date the approval of the budget is withdrawn.", "format":"date-time", "exampleSetFlag":false }, "approveByUserId":{ "type":"integer", "description":"The user who approved the budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveByUserName":{ "maxLength":255, "type":"string", "description":"The username of the user who approves the budget.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetStatus":{ "type":"string", "description":"The status of the budget.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "lastModifiedById":{ "type":"integer", "description":"The user who last made changes to the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserId":{ "type":"integer", "description":"The user who rejected the budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserName":{ "maxLength":255, "type":"string", "description":"The username of the user who rejected the budget.", "exampleSetFlag":false, "types":[ "string" ] }, "rejectDate":{ "type":"string", "description":"The date the budget was rejected.", "format":"date-time", "exampleSetFlag":false }, "submitByUserId":{ "type":"integer", "description":"The user who submitted the budget for review.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetId":{ "type":"integer", "description":"The ID of the program budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"The date the project budget was approved.", "format":"date-time", "exampleSetFlag":false }, "programId":{ "type":"integer", "description":"The unique identifier for a program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetInput":{ "title":"ApiEntityProgramBudgetInput", "type":"object", "properties":{ "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for a program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProgramBudget object, a unique ProgramBudget object can be identified by the following combinations of the fields.
                                                                                                                                                                • programId
                                                                                                                                                                • programCode,workspaceId
                                                                                                                                                                • programCode,workspaceCode
                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetTransaction":{ "title":"ApiEntityProgramBudgetTransaction", "required":[ "transferFromProgramBudgetItemId" ], "type":"object", "properties":{ "programBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a budget transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransactionCode":{ "maxLength":60, "type":"string", "description":"The system-generated unique identifier for the budget transaction item.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransactionCost":{ "description":"The cost data of a program budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCost" } ] }, "programBudgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a program budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetCbsTemplateCodeId":{ "type":"integer", "description":"The name of the CBS Code associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemName":{ "maxLength":255, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "changeMode":{ "type":"string", "description":"specifies the mode of the program budget change transaction.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "AUTO", "MANUAL", "CHANGE" ] }, "desiredCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a program budget item to be provided while adding a new program budget item through a program budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "transactionType":{ "type":"string", "description":"Specifies whether the budget row is an original, change, or transfer value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CHANGE", "TRANSFER" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "budgetHours":{ "type":"number", "description":"The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.", "format":"double", "exampleSetFlag":false }, "budgetCostCategoryId":{ "type":"integer", "description":"The cost category ID of the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"The date the transaction was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program budget transfer transaction.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "transferFromProgramBudgetItemId":{ "type":"integer", "description":"The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToProgramBudgetItemId":{ "type":"integer", "description":"The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a budget transfer of an object to which the program budget item is added in a destination transaction of a cross entity transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityTransferFromId":{ "type":"integer", "description":"The system-generated identifier of a budget item added in a cross entity transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a project to program Budget Transfer, the project budget item ID has to be given in a destination transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a source budget transaction which has cross entity budget item involved.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToCostCategoryId":{ "type":"integer", "description":"The cost category ID of the source budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferFromCostCategoryId":{ "type":"integer", "description":"The cost category ID of the destination budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetTransferType":{ "type":"string", "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TO", "FROM" ] }, "transferFromCBSId":{ "type":"integer", "description":"The CBS code of the source budget line item. This identifies the CBS code of the budget line item you are transferring money from through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToCBSId":{ "type":"integer", "description":"The CBS code of the destination budget line item. This identifies the CBS code of the budget line item you are transferring money to through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransferId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetTransactionConfiguredFieldValue":{ "title":"ApiEntityProgramBudgetTransactionConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransactionConfiguredFieldValueId":{ "type":"integer", "description":"The system generated identifier of a Program Budget Transaction Configured Field assigned to a Program Budget Transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a Program Budget Transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetTransactionCost":{ "title":"ApiEntityProgramBudgetTransactionCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier for a transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitRate":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item detail.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace1":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace2":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace3":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "laborRate":{ "type":"number", "description":"The cost per labor hour of the budget line item detail.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace1":{ "type":"number", "description":"The cost per labor hour of the budget line item based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace2":{ "type":"number", "description":"The cost per labor hour of the budget line item based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace3":{ "type":"number", "description":"The cost per labor hour of the budget line item based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentCost":{ "type":"number", "description":"The current cost of the associated budget line item.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace1":{ "type":"number", "description":"The total cost of the program budget, including all transfers and changes, based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace2":{ "type":"number", "description":"The total cost of the program budget, including all transfers and changes, based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace3":{ "type":"number", "description":"The total cost of the program budget, including all transfers and changes, based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "amountCost":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions.", "format":"double", "exampleSetFlag":false }, "amountCostWorkspace1":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions, based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "amountCostWorkspace2":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions, based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "amountCostWorkspace3":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions, based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetStatusTransitionHistory":{ "title":"ApiEntityProgramBudgetStatusTransitionHistory", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Comments included by the user who changed the status of the record.", "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"The date the status of the record was changed.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetStatusTransitionHistoryId":{ "type":"integer", "description":"A unique identifier for the change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The username of the user who changed the status of the record.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetId":{ "type":"integer", "description":"The ID of the program budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "statusTransitionType":{ "type":"string", "description":"The date the status of the record was changed.", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "REJECT", "DRAFT" ] }, "userId":{ "type":"integer", "description":"The user who changed the status of the record.", "format":"int64", "readOnly":true, "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetChange":{ "title":"ApiEntityProgramBudgetChange", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetChangeTransactions":{ "type":"array", "description":"List of all program budget change transactions of a program budget change.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "withdrawApprovalByUserId":{ "type":"integer", "description":"The username of the user that with withdrew approval of the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "withdrawApprovalByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who withdrew a program budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetChangeCost":{ "description":"An object containing the cost fields associated with the program budget change.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeCost" } ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details supporting the change request.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetChangeCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the program budget change request.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a program budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "submitByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who submitted a program budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "submitDate":{ "type":"string", "description":"Date the item was submitted.", "format":"date-time", "exampleSetFlag":false }, "withdrawApprovalDate":{ "type":"string", "description":"Date the item was withdrawn.", "format":"date-time", "exampleSetFlag":false }, "approveByUserId":{ "type":"integer", "description":"The username of the user that approved the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who approved a program budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "lastModifiedById":{ "type":"integer", "description":"The username of the user who last made changes to the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserId":{ "type":"integer", "description":"The username of the user that rejected the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who rejected a program budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "rejectDate":{ "type":"string", "description":"Date the item was rejected.", "format":"date-time", "exampleSetFlag":false }, "submitByUserId":{ "type":"integer", "description":"The username of the user that submitted the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetId":{ "type":"integer", "description":"The system-generated identifier of a program budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"Date the item was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program budget change.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the program budget change request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetChangeConfiguredFieldValue":{ "title":"ApiEntityProgramBudgetChangeConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetChangeConfiguredFieldValueId":{ "type":"integer", "description":"The system generated identifier of a Program Budget Change Configured Field assigned to a Program Budget Change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a Program Budget Change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetChangeCost":{ "title":"ApiEntityProgramBudgetChangeCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "totalCost":{ "type":"number", "description":"The cost to be added or subtracted from the program budget.", "format":"double", "exampleSetFlag":false }, "totalCostWorkspace1":{ "type":"number", "description":"The cost to be added or subtracted from the program budget, based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalCostWorkspace2":{ "type":"number", "description":"The cost to be added or subtracted from the program budget, based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalCostWorkspace3":{ "type":"number", "description":"The cost to be added or subtracted from the program budget, based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "programBudgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a program budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetChangeTransaction":{ "title":"ApiEntityProgramBudgetChangeTransaction", "type":"object", "properties":{ "programBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier for a transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransactionCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the budget line item.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransactionCost":{ "description":"The cost data of a program budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCost" } ] }, "programBudgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a program budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetCbsTemplateCodeId":{ "type":"integer", "description":"The name of the CBS Code associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemName":{ "maxLength":255, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "changeMode":{ "type":"string", "description":"specifies the mode of the program budget change transaction.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "AUTO", "MANUAL", "CHANGE" ] }, "desiredCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a program budget item to be provided while adding a new program budget item through a program budget change.", "exampleSetFlag":false, "types":[ "string" ] }, "transactionType":{ "type":"string", "description":"Specifies whether the budget row is an original, change, or transfer value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CHANGE", "TRANSFER" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "budgetHours":{ "type":"number", "description":"The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.", "format":"double", "exampleSetFlag":false }, "budgetCostCategoryId":{ "type":"integer", "description":"The type of cost associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"The date the transaction was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program budget change transaction.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetChangeConfiguredFieldValueInput":{ "title":"ApiEntityProgramBudgetChangeConfiguredFieldValueInput", "type":"object", "properties":{ "programBudgetChangeConfiguredFieldValueId":{ "type":"integer", "description":"The system generated identifier of a Program Budget Change Configured Field assigned to a Program Budget Change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProgramBudgetChangeConfiguredFieldValue object, a unique ProgramBudgetChangeConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                  • programBudgetChangeConfiguredFieldValueId
                                                                                                                                                                  • columnDefinitionId
                                                                                                                                                                  • columnName
                                                                                                                                                                  • columnLabel
                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetChangeInput":{ "title":"ApiEntityProgramBudgetChangeInput", "required":[ "programId" ], "type":"object", "properties":{ "programBudgetChangeTransactions":{ "type":"array", "description":"List of all program budget change transactions of a program budget change.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeTransactionInput", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details supporting the change request.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetChangeCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the program budget change request.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a program budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program budget change.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetChangeConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProgramBudgetChange object, a unique ProgramBudgetChange object can be identified by the following combinations of the fields.
                                                                                                                                                                    • programBudgetId
                                                                                                                                                                    • programId
                                                                                                                                                                    • programCode,workspaceId
                                                                                                                                                                    • programCode,workspaceCode
                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetChangeTransactionInput":{ "title":"ApiEntityProgramBudgetChangeTransactionInput", "type":"object", "properties":{ "programBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier for a transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransactionCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the program budget line item detail.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransactionCost":{ "description":"The cost data of a program budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCostInput" } ] }, "programBudgetChangeId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetCbsTemplateCodeId":{ "type":"integer", "description":"The name of the CBS Code associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemName":{ "maxLength":255, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "desiredCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"A unique identifier for the budget item (Add Budget Line).", "exampleSetFlag":false, "types":[ "string" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "budgetCostCategoryId":{ "type":"integer", "description":"The type of cost associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProgramBudgetChangeTransaction object, a unique ProgramBudgetChangeTransaction object can be identified by the following combinations of the fields.
                                                                                                                                                                      • programBudgetTransactionId
                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetTransactionConfiguredFieldValueInput":{ "title":"ApiEntityProgramBudgetTransactionConfiguredFieldValueInput", "type":"object", "properties":{ "programBudgetTransactionConfiguredFieldValueId":{ "type":"integer", "description":"The system generated identifier of a Program Budget Transaction Configured Field assigned to a Program Budget Transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProgramBudgetTransactionConfiguredFieldValue object, a unique ProgramBudgetTransactionConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                        • programBudgetTransactionConfiguredFieldValueId
                                                                                                                                                                        • columnDefinitionId
                                                                                                                                                                        • columnName
                                                                                                                                                                        • columnLabel
                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetTransactionCostInput":{ "title":"ApiEntityProgramBudgetTransactionCostInput", "required":[ "amountCostCOR" ], "type":"object", "properties":{ "programBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier for a transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitRateCOR":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "laborRateCOR":{ "type":"number", "description":"The cost per labor hour of the budget line item. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "amountCostCOR":{ "type":"number", "description":"The amount that the budget row has changed as the result of transactions. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false } }, "description":"This entity represents a ProgramBudgetTransactionCost object, a unique ProgramBudgetTransactionCost object can be identified by the following combinations of the fields.
                                                                                                                                                                          • programBudgetTransactionId
                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetChangeStatusTransitionHistory":{ "title":"ApiEntityProgramBudgetChangeStatusTransitionHistory", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Comments included by the user who changed the status of the record.", "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"The date the status of the record was changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetChangeStatusTransitionHistoryId":{ "type":"integer", "description":"The system-generated identifier of a budget change status transition history.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The name of a user associated with the status transition history.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetChangeId":{ "type":"integer", "description":"The system-generated identifier of a budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "statusTransitionType":{ "type":"string", "description":"The type of change made to the record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "REJECT", "DRAFT" ] }, "userId":{ "type":"integer", "description":"The user who changed the status of the record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetItem":{ "title":"ApiEntityProgramBudgetItem", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetItemCost":{ "description":"Contains Program Budget Item cost related fields.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramBudgetItemCost" } ] }, "programBudgetItemCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the program budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The cost category assigned to this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "unitsOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "abbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of program budget item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetChangeId":{ "type":"integer", "description":"Indicates whether the budget item originated in a budget change.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemId":{ "type":"integer", "description":"The system-generated identifier for a budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The type of cost associated with the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "cbsTemplateCodeId":{ "type":"integer", "description":"The unique identifier of the CBS Code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetId":{ "type":"integer", "description":"The ID of the program budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget item.", "format":"double", "exampleSetFlag":false }, "budgetHours":{ "type":"number", "description":"The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetItemConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code value of the CBS code. The code may have one or more segments according the ot the segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetItemConfiguredFieldValue":{ "title":"ApiEntityProgramBudgetItemConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetItemConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Budget Item Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemId":{ "type":"integer", "description":"The system-generated identifier for a budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetItemCost":{ "title":"ApiEntityProgramBudgetItemCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "originalCost":{ "minimum":0, "type":"number", "description":"The original cost of the budget line item.", "format":"double", "exampleSetFlag":false }, "originalCostWorkspace1":{ "type":"number", "description":"The total original cost of the program budget, before transfers and changes, based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "originalCostWorkspace2":{ "type":"number", "description":"The total original cost of the program budget, before transfers and changes, based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "originalCostWorkspace3":{ "type":"number", "description":"The total original cost of the project budget, before transfers and changes, based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "programBudgetItemId":{ "type":"integer", "description":"The system-generated identifier for a budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitRate":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace1":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace2":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unitRateWorkspace3":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "laborRate":{ "type":"number", "description":"The cost per labor hour of the budget line item.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace1":{ "type":"number", "description":"The cost per labor hour of the budget line item based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace2":{ "type":"number", "description":"The cost per labor hour of the budget line item based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "laborRateWorkspace3":{ "type":"number", "description":"The cost per labor hour of the budget line item based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "currentCost":{ "type":"number", "description":"The current cost of the budget line item.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace1":{ "type":"number", "description":"The total cost of the program budget, including all transfers and changes, based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace2":{ "type":"number", "description":"The total cost of the program budget, including all transfers and changes, based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "currentCostWorkspace3":{ "type":"number", "description":"The total cost of the program budget, including all transfers and changes, based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetItemConfiguredFieldValueInput":{ "title":"ApiEntityProgramBudgetItemConfiguredFieldValueInput", "type":"object", "properties":{ "programBudgetItemConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Budget Item Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProgramBudgetItemConfiguredFieldValue object, a unique ProgramBudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                            • programBudgetItemConfiguredFieldValueId
                                                                                                                                                                            • columnDefinitionId
                                                                                                                                                                            • columnName
                                                                                                                                                                            • columnLabel
                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetItemCostInput":{ "title":"ApiEntityProgramBudgetItemCostInput", "type":"object", "properties":{ "unitRateCOR":{ "type":"number", "description":"The cost per Unit of Measure for the budget line item. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "laborRateCOR":{ "type":"number", "description":"The cost per labor hour of the budget line item. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "originalCostCOR":{ "minimum":0, "type":"number", "description":"The original cost of the budget line item. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "programBudgetItemId":{ "type":"integer", "description":"The system-generated identifier for a budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetItemInput":{ "title":"ApiEntityProgramBudgetItemInput", "type":"object", "properties":{ "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "programBudgetItemCost":{ "description":"Contains Program Budget Item cost related fields.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramBudgetItemCostInput" } ] }, "programBudgetItemCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier of the program budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The cost category assigned to this budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "unitsOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "abbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of program budget item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemId":{ "type":"integer", "description":"The system-generated identifier for a budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The type of cost associated with the budget item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "cbsTemplateCodeId":{ "type":"integer", "description":"The unique identifier of the CBS Code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget item.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetItemConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProgramBudgetItem object, a unique ProgramBudgetItem object can be identified by the following combinations of the fields.
                                                                                                                                                                              • programBudgetItemId
                                                                                                                                                                              • programBudgetItemCode,programId
                                                                                                                                                                              • programBudgetItemCode,programCode,workspaceCode
                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetTransfer":{ "title":"ApiEntityProgramBudgetTransfer", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransferCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the program budget transfer request.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransferTransactions":{ "type":"array", "description":"List of all program budget transfer transactions of a program budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "projectBudgetTransferTransactions":{ "type":"array", "description":"List of all project budget transactions of a program budget transfer. This field represents the transactions which involves project budget item in a program budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferTransaction", "exampleSetFlag":false }, "types":[ "array" ] }, "withdrawApprovalByUserId":{ "type":"integer", "description":"The username of the user that with withdrew approval of the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "withdrawApprovalByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who withdrew a program budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information about the program budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "submitByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who submitted a program budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "submitDate":{ "type":"string", "description":"Date the item was submitted.", "format":"date-time", "exampleSetFlag":false }, "withdrawApprovalDate":{ "type":"string", "description":"Date the item was withdrawn.", "format":"date-time", "exampleSetFlag":false }, "approveByUserId":{ "type":"integer", "description":"The username of the user that approved the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who approved a program budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "lastModifiedById":{ "type":"integer", "description":"The username of the user who last made changes to the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserId":{ "type":"integer", "description":"The username of the user that rejected the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who rejected a program budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "rejectDate":{ "type":"string", "description":"Date the item was rejected.", "format":"date-time", "exampleSetFlag":false }, "submitByUserId":{ "type":"integer", "description":"The username of the user that submitted the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier of a program.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetId":{ "type":"integer", "description":"The system-generated identifier of a program budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier for a budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"Date the item was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "programBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a program budget transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the program budget transfer request. Pending: The change request is awaiting a decision. Approved: The change request was approved. Rejected: The change request was not approved.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetTransferConfiguredFieldValue":{ "title":"ApiEntityProgramBudgetTransferConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransferConfiguredFieldValueId":{ "type":"integer", "description":"The system generated identifier of a Program Budget Transfer Configured Field assigned to a Program Budget Transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a Program Budget Transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetTransferTransaction":{ "title":"ApiEntityProgramBudgetTransferTransaction", "required":[ "transferFromProgramBudgetItemId" ], "type":"object", "properties":{ "transferFromProgramBudgetItemId":{ "type":"integer", "description":"The unique identifier for the source budget line item. This identifies the ID of the budget item item you are transferring money from through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToProgramBudgetItemId":{ "type":"integer", "description":"The unique identifier for the destination budget line item. This identifies the ID of the budget item you are transferring money to through the transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a budget transfer of an object to which the program budget item is added in a destination transaction of a cross entity transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityTransferFromId":{ "type":"integer", "description":"The system-generated identifier of a budget item added in a cross entity transfer. This field is required to be provided in a destination transaction of a cross entity transfer to identify the source budget item. For example, In a project to program Budget Transfer, the project budget item ID has to be given in a destination transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a source budget transaction which has cross entity budget item involved.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToCostCategoryId":{ "type":"integer", "description":"The cost category ID of the source budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferFromCostCategoryId":{ "type":"integer", "description":"The cost category ID of the destination budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier of a budget transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransactionCode":{ "maxLength":60, "type":"string", "description":"The system-generated unique identifier for the budget transaction item.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransactionCost":{ "description":"The cost data of a program budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCost" } ] }, "budgetTransferType":{ "type":"string", "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TO", "FROM" ] }, "transferFromCBSId":{ "type":"integer", "description":"The CBS code of the source budget line item. This identifies the CBS code of the budget line item you are transferring money from through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToCBSId":{ "type":"integer", "description":"The CBS code of the destination budget line item. This identifies the CBS code of the budget line item you are transferring money to through the transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "budgetCbsTemplateCodeId":{ "type":"integer", "description":"The name of the CBS Code associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemName":{ "maxLength":255, "type":"string", "description":"The name of the budget item.", "exampleSetFlag":false, "types":[ "string" ] }, "transactionType":{ "type":"string", "description":"Specifies whether the budget row is an original, change, or transfer value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ORIGINAL", "CHANGE", "TRANSFER" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "budgetHours":{ "type":"number", "description":"The number of hours needed to complete the budget details line item. Calculated as Production Rate multiplied by Quantity.", "format":"double", "exampleSetFlag":false }, "budgetCostCategoryId":{ "type":"integer", "description":"The cost category ID of the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"The date the transaction was approved.", "format":"date-time", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program budget transfer transaction.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "programBudgetTransferId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the transaction. Indicates whether the transaction is approved, pending, draft, or rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] } }, "exampleSetFlag":false }, "ApiEntityProgramBudgetTransferConfiguredFieldValueInput":{ "title":"ApiEntityProgramBudgetTransferConfiguredFieldValueInput", "type":"object", "properties":{ "programBudgetTransferConfiguredFieldValueId":{ "type":"integer", "description":"The system generated identifier of a Program Budget Transfer Configured Field assigned to a Program Budget Transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProgramBudgetTransferConfiguredFieldValue object, a unique ProgramBudgetTransferConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                • programBudgetTransferConfiguredFieldValueId
                                                                                                                                                                                • columnDefinitionId
                                                                                                                                                                                • columnName
                                                                                                                                                                                • columnLabel
                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetTransferInput":{ "title":"ApiEntityProgramBudgetTransferInput", "required":[ "programId" ], "type":"object", "properties":{ "programBudgetTransferCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the program budget transfer request.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransferTransactions":{ "type":"array", "description":"List of all program budget transfer transactions of a program budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferTransactionInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectBudgetTransferTransactions":{ "type":"array", "description":"List of all project budget transactions of a program budget transfer. This field represents the transactions which involves project budget item in a program budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityBudgetTransferTransactionInput", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information about the program budget transfer.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier of a program.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetItemId":{ "type":"integer", "description":"The system-generated identifier for a budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program budget transfer.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransferConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a program budget transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProgramBudgetTransfer object, a unique ProgramBudgetTransfer object can be identified by the following combinations of the fields.
                                                                                                                                                                                  • programBudgetTransferId
                                                                                                                                                                                  • programBudgetTransferCode,programId
                                                                                                                                                                                  • programBudgetTransferCode,programCode,workspaceCode
                                                                                                                                                                                  • programBudgetTransferCode,programBudgetId
                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetTransferTransactionInput":{ "title":"ApiEntityProgramBudgetTransferTransactionInput", "type":"object", "properties":{ "transferFromProgramBudgetItemId":{ "type":"integer", "description":"The budget ID of the Transfer From Budget record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "transferToProgramBudgetItemId":{ "type":"integer", "description":"The budget ID of the Transfer To Budget record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier for a transfer.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityTransferFromId":{ "type":"integer", "description":"The budget ID of the Transfer From project budget record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crossEntityBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier for a transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransactionId":{ "type":"integer", "description":"The system-generated identifier for a transaction.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetTransactionCode":{ "maxLength":60, "type":"string", "description":"The unique identifier of the program budget line item detail.", "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransactionCost":{ "description":"The cost data of a program budget transaction.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionCostInput" } ] }, "budgetTransferType":{ "type":"string", "description":"Specifies whether the budget row is transfer from budget record or transfer to budget record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TO", "FROM" ] }, "budgetCbsTemplateCodeId":{ "type":"integer", "description":"The name of the CBS Code associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programBudgetItemId":{ "type":"integer", "description":"A unique identifier for the budget item (Change Budget Line).", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The Unit of Measure used for the budget line item detail.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The number of each budget line item needed to complete the work.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "productionRate":{ "minimum":"0.000010", "type":"number", "description":"The number of hours per unit of measure needed to complete the budget line item.", "format":"double", "exampleSetFlag":false }, "budgetCostCategoryId":{ "type":"integer", "description":"The type of cost associated with the budget line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramBudgetTransactionConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programBudgetTransferId":{ "type":"integer", "description":"This is an intermediary field that the system uses to calculate other values. It does not correspond to any field users can see in the user interface.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProgramBudgetTransferTransaction object, a unique ProgramBudgetTransferTransaction object can be identified by the following combinations of the fields.
                                                                                                                                                                                    • programBudgetTransactionId
                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityProgramBudgetTransferStatusTransitionHistory":{ "title":"ApiEntityProgramBudgetTransferStatusTransitionHistory", "required":[ "programBudgetTransferStatusTransitionHistoryId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Comments included by the user who changed the status of the record.", "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"The date the status of the record was changed.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "programBudgetTransferStatusTransitionHistoryId":{ "type":"integer", "description":"The system-generated identifier of a program budget transfer status transition history.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The username of the user who changed the status of the record.", "exampleSetFlag":false, "types":[ "string" ] }, "statusTransitionType":{ "type":"string", "description":"The type of change made to the record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "REJECT", "DRAFT" ] }, "programBudgetTransferId":{ "type":"integer", "description":"The system-generated identifier of a program budget transfer. ", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userId":{ "type":"integer", "description":"The user who changed the status of the record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramMeasureValue":{ "title":"ApiEntityProgramMeasureValue", "type":"object", "properties":{ "actualDerivedValue":{ "type":"number", "description":"The actual value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetBaseValue":{ "type":"number", "description":"The base target value for a measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetDerivedValue":{ "type":"number", "description":"The target value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetExpressionValue":{ "type":"number", "description":"The target value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualBaseValue":{ "type":"number", "description":"The base actual value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualExpressionValue":{ "type":"number", "description":"The actual expression value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "programMeasureValueId":{ "type":"integer", "description":"The unique identifier of a program measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureEntryType":{ "type":"string", "description":"The type of a measure entry.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COMPUTE" ] }, "lastCalculatedDate":{ "type":"string", "description":"The date on which the measure was last calculated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The system-generated identifier of a program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueProgramRisk":{ "title":"ApiEntityCodeValueProgramRisk", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueProgramRiskId":{ "type":"integer", "description":"The unique identifier of a risk code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRisk":{ "title":"ApiEntityProgramRisk", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskMitigationFinishAfterExposure":{ "type":"string", "description":"One or more response actions finish after the start of the risk exposure.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TRUE", "FALSE", "MISSING_DATES" ] }, "programRiskQuantifiedOtherImpacts":{ "type":"array", "description":"The impact this program risk will have on other data.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskQuantifiedOtherImpact", "exampleSetFlag":false }, "types":[ "array" ] }, "programRiskMitigationEarliestStartDate":{ "type":"string", "description":"The earliest start date of the risk's response actions.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskMitigationLatestFinishDate":{ "type":"string", "description":"The latest finish date of the risk's response actions.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskMitigationCount":{ "type":"integer", "description":"The number of response actions on the risk.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskMitigationRolledUpStatus":{ "type":"string", "description":"The rolled up status of the risk's response actions.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "SANCTIONED", "NOT_STARTED", "REJECTED", "IN_PROGRESS", "COMPLETED" ] }, "programRiskQuantifiedCostImpact":{ "description":"The impact this program risk will have on cost data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramRiskQuantifiedCostImpact" } ] }, "programRiskFinancial":{ "description":"The financial fields associated with a program risk.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramRiskFinancial" } ] }, "codeValuesProgramRisk":{ "type":"array", "description":"The list of code values for a program risk. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProgramRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "programRiskStatus":{ "type":"string", "description":"The status of the risk.
                                                                                                                                                                                      Proposed: The risk is identified and awaits approval.
                                                                                                                                                                                      Open: The risk is approved as a valid risk and is awaiting management.
                                                                                                                                                                                      Monitoring: The risk has been managed and is being monitored.
                                                                                                                                                                                      Impacting: The risk is currently impacting the project.
                                                                                                                                                                                      Cannot Impact: The risk did not happen and can no longer happen.
                                                                                                                                                                                      Impacted: The risk occurred.
                                                                                                                                                                                      Rejected: The risk is not seen as a valid risk to the project and therefore will not be tracked and managed by the project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "OPEN", "MONITORING", "IMPACTING", "REJECTED", "CANNOT_IMPACT", "IMPACTED" ] }, "programRiskImpacts":{ "type":"array", "description":"The impact of the program risk.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskImpact", "exampleSetFlag":false }, "types":[ "array" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program risk.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program to which the risk was added.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cause":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A description of the cause of the risk.", "exampleSetFlag":false }, "state":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "country":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "quantifiedPostResponseProbabilityThreshold":{ "type":"number", "description":"The probability threshold that a risk will occur after implementing a response action.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scheduleImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "probabilityImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "quantifiedScheduleThreshold":{ "type":"number", "description":"The estimated impact size that the risk will have on the project schedule before implementing a response action.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedProbabilityThreshold":{ "type":"number", "description":"The estimated probability that a risk will occur before implementing a response action.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedPostResponseScheduleThreshold":{ "type":"number", "description":"The estimated impact size that the risk will have on the project schedule after implementing a response action.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary of the risk.", "exampleSetFlag":false }, "hasPostResponseData":{ "type":"boolean", "description":"Determines whether this risk has post-response values.", "exampleSetFlag":false, "types":[ "boolean" ] }, "identifiedDate":{ "type":"string", "description":"The date the risk was added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "riskType":{ "type":"string", "description":"The type of risk. Valid values are Threat, Opportunity, Weather and Risk Factor.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "THREAT", "OPPORTUNITY", "WEATHER", "RISK_FACTOR" ] }, "identifiedById":{ "type":"integer", "description":"The user who added the risk to the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "postScore":{ "type":"integer", "description":"The post-response risk score calculated using the project risk matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "costImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified cost distribution is used to determine the cost impact for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualScheduleImpact":{ "type":"number", "description":"The actual schedule impact due to the risk occurring.", "format":"double", "exampleSetFlag":false }, "impactedDate":{ "type":"string", "description":"The date the risk impacted the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "preResponseMeanDelay":{ "type":"number", "description":"The estimated average project delay duration before implementing a response action.", "format":"double", "exampleSetFlag":false }, "postResponseMeanDelay":{ "type":"number", "description":"The estimated average project delay duration before implementing a response action.", "format":"double", "exampleSetFlag":false }, "locationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                      This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                      This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "riskSourceType":{ "type":"string", "description":"The source type of the risk i.e. Project or Program.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT", "PROGRAM" ] }, "scoreImprovement":{ "type":"integer", "description":"The change in project risk score due to the response action(s).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "responseEffectiveness":{ "type":"number", "description":"The effectiveness of the risk's response actions expressed as a ratio of the Exposure Improvement and the Total At Completion Response Cost.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "effect":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The resulting effect of the presence of the risk.", "exampleSetFlag":false }, "score":{ "type":"integer", "description":"The pre-response risk score calculated using the project risk matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ownerId":{ "type":"integer", "description":"The name of the user who is assigned to manage the risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "city":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskConfiguredFieldValue":{ "title":"ApiEntityProgramRiskConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Program Risk Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskFinancial":{ "title":"ApiEntityProgramRiskFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "preQuantifiedCostThreshold":{ "type":"number", "description":"The estimated impact size that the risk will have on the project cost before implementing a response action.", "format":"double", "exampleSetFlag":false }, "postQuantifiedCostThreshold":{ "type":"number", "description":"The estimated impact size that the risk will have on the project cost after implementing a response action.", "format":"double", "exampleSetFlag":false }, "actualResponseCostProject":{ "minimum":0, "type":"number", "description":"The actual cost of implementing a response action. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingTotalResponseCost":{ "type":"number", "description":"The total Remaining Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "preRemainingTotalResponseCost":{ "type":"number", "description":"The total Pre-Response Remaining Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "postRemainingTotalResponseCost":{ "type":"number", "description":"The total Post-Response Remaining Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "atCompletionTotalResponseCost":{ "type":"number", "description":"The total At Completion Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "preAtCompletionTotalResponseCost":{ "type":"number", "description":"The total Pre-Response At Completion Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "postAtCompletionTotalResponseCost":{ "type":"number", "description":"The total Post-Response At Completion Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "preResponseExposureWorkspace1":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "preResponseExposureWorkspace2":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "preResponseExposureWorkspace3":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "postResponseExposureWorkspace1":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "postResponseExposureWorkspace2":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "postResponseExposureWorkspace3":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "preExposureCost":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This field is in base currency and is calculated from preExposureCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preExposureCostProject":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "postExposureCost":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This field is in base currency and is calculated from postExposureCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postExposureCostProject":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualResponseCost":{ "minimum":0, "type":"number", "description":"The actual cost of implementing the response action. This field is in base currency and is calculated from actualResponseCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostImpact":{ "minimum":0, "type":"number", "description":"The actual cost impact due to the risk occurring.", "format":"double", "exampleSetFlag":false }, "contingency":{ "minimum":0, "type":"number", "description":"The allowable risk cost should the risk occur.", "format":"double", "exampleSetFlag":false }, "preActualResponseCost":{ "type":"number", "description":"The total Pre-Response Actual Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "postActualResponseCost":{ "type":"number", "description":"The total Post-Response Actual Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "exposureImprovementCost":{ "type":"number", "description":"The difference between the Pre-Response Exposure and the Post-Response Exposure.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskImpact":{ "title":"ApiEntityProgramRiskImpact", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postRiskScoreThresholdId":{ "type":"integer", "description":"The system-generated unique identifier for the post-response impact threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postRiskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk scoring threshold.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreThresholdId":{ "type":"integer", "description":"The system-generated unique identifier for the pre-response impact threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the risk score threshold of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "riskImpactId":{ "type":"integer", "description":"A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The risk score type name of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The system-generated unique identifier of the risk score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project risk code of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskQuantifiedCostImpact":{ "title":"ApiEntityProgramRiskQuantifiedCostImpact", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "preResponseDistributionShape":{ "type":"string", "description":"Determines the distribution that best models the three-point estimates for the cost impact before a response. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "postResponseDistributionShape":{ "type":"string", "description":"Determines the distribution that best models the three-point estimates for the cost impact after a response.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "preResponseMinimumProject":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "preResponseMinimumWorkspace1":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMinimumWorkspace2":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMinimumWorkspace3":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikelyProject":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikelyWorkspace1":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikelyWorkspace2":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikelyWorkspace3":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMaximumProject":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "preResponseMaximumWorkspace1":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMaximumWorkspace2":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMaximumWorkspace3":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMinimumProject":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "postResponseMinimumWorkspace1":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMinimumWorkspace2":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMinimumWorkspace3":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikelyProject":{ "type":"number", "description":"The most likely cost of a risk event that has occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikelyWorkspace1":{ "type":"number", "description":"The most likely cost of a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikelyWorkspace2":{ "type":"number", "description":"The most likely cost of a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikelyWorkspace3":{ "type":"number", "description":"The most likely probability that a risk event will occur.", "format":"double", "exampleSetFlag":false }, "postResponseMaximumProject":{ "type":"number", "description":"The maximum cost of responding to a risk event. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "postResponseMaximumWorkspace1":{ "type":"number", "description":"The maximum cost of responding to a risk event.", "format":"double", "exampleSetFlag":false }, "postResponseMaximumWorkspace2":{ "type":"number", "description":"The maximum cost of responding to a risk event.", "format":"double", "exampleSetFlag":false }, "postResponseMaximumWorkspace3":{ "type":"number", "description":"The maximum cost of responding to a risk event.", "format":"double", "exampleSetFlag":false }, "preResponseMinimum":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMinimumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikely":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMostLikelyProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preResponseMaximum":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMaximumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMinimum":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred. This field is in base currency and is calculated from postResponseMinimumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikely":{ "type":"number", "description":"The most likely cost of a risk event that has occurred. This field is in base currency and is calculated from postResponseMostLikelyProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMaximum":{ "type":"number", "description":"The maximum cost of responding to a risk event. This field is in base currency and is calculated from postResponseMaximumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "quantifiedCostImpactId":{ "type":"integer", "description":"The unique identifier of a cost impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskQuantifiedOtherImpact":{ "title":"ApiEntityProgramRiskQuantifiedOtherImpact", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "shape":{ "type":"string", "description":"The distribution that best models the three-point estimates for risk probabilities or risk schedule impacts.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "minimum":{ "type":"number", "description":"The minimum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "maximum":{ "type":"number", "description":"The maximum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedOtherImpactId":{ "type":"integer", "description":"The unique identifier of a risk impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scoreType":{ "type":"string", "description":"The type of an impact score.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ] }, "mostLikely":{ "type":"number", "description":"The most likely probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "preOrPostResponse":{ "type":"string", "description":"Indicates whether a risk impact is measured pre or post response.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_RESPONSE", "POST_RESPONSE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueProgramRiskInput":{ "title":"ApiEntityCodeValueProgramRiskInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueProgramRiskId":{ "type":"integer", "description":"The unique identifier of a risk code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueProgramRisk object, a unique CodeValueProgramRisk object can be identified by the following combinations of the fields.
                                                                                                                                                                                      • codeValueProgramRiskId
                                                                                                                                                                                      • codeValueId
                                                                                                                                                                                      • codeTypeId,codeValueCode
                                                                                                                                                                                      • codeTypeCode,codeValueCode
                                                                                                                                                                                      • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                      • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                      • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                      • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                      • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                      • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityProgramRiskConfiguredFieldValueInput":{ "title":"ApiEntityProgramRiskConfiguredFieldValueInput", "type":"object", "properties":{ "programRiskConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Program Risk Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProgramRiskConfiguredFieldValue object, a unique ProgramRiskConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                        • programRiskConfiguredFieldValueId
                                                                                                                                                                                        • columnDefinitionId
                                                                                                                                                                                        • columnName
                                                                                                                                                                                        • columnLabel
                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityProgramRiskFinancialInput":{ "title":"ApiEntityProgramRiskFinancialInput", "required":[ "programRiskId" ], "type":"object", "properties":{ "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualCostImpact":{ "minimum":0, "type":"number", "description":"The actual cost impact due to the risk occurring.", "format":"double", "exampleSetFlag":false }, "contingency":{ "minimum":0, "type":"number", "description":"The allowable risk cost should the risk occur.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityProgramRiskImpactInput":{ "title":"ApiEntityProgramRiskImpactInput", "required":[ "programRiskId", "riskScoreThresholdId", "riskScoreTypeId" ], "type":"object", "properties":{ "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postRiskScoreThresholdId":{ "type":"integer", "description":"The system-generated unique identifier for the post-response impact threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postRiskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk scoring threshold.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreThresholdId":{ "type":"integer", "description":"The system-generated unique identifier for the pre-response impact threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the risk score threshold of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "riskImpactId":{ "type":"integer", "description":"A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The risk score type name of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The system-generated unique identifier of the risk score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskInput":{ "title":"ApiEntityProgramRiskInput", "required":[ "programId", "riskName" ], "type":"object", "properties":{ "programRiskQuantifiedOtherImpacts":{ "type":"array", "description":"The impact this program risk will have on other data.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskQuantifiedOtherImpactInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programRiskQuantifiedCostImpact":{ "description":"The impact this program risk will have on cost data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramRiskQuantifiedCostImpactInput" } ] }, "programRiskFinancial":{ "description":"The financial fields associated with a program risk.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramRiskFinancialInput" } ] }, "codeValuesProgramRisk":{ "type":"array", "description":"The list of code values for a program risk. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProgramRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programRiskStatus":{ "type":"string", "description":"The status of the risk.
                                                                                                                                                                                          Proposed: The risk is identified and awaits approval.
                                                                                                                                                                                          Open: The risk is approved as a valid risk and is awaiting management.
                                                                                                                                                                                          Monitoring: The risk has been managed and is being monitored.
                                                                                                                                                                                          Impacting: The risk is currently impacting the project.
                                                                                                                                                                                          Cannot Impact: The risk did not happen and can no longer happen.
                                                                                                                                                                                          Impacted: The risk occurred.
                                                                                                                                                                                          Rejected: The risk is not seen as a valid risk to the project and therefore will not be tracked and managed by the project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "OPEN", "MONITORING", "IMPACTING", "REJECTED", "CANNOT_IMPACT", "IMPACTED" ] }, "programRiskImpacts":{ "type":"array", "description":"The impact of the program risk.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskImpactInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a program risk.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProgramRiskConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program to which the risk was added.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cause":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A description of the cause of the risk.", "exampleSetFlag":false }, "state":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "country":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "scheduleImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "probabilityImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary of the risk.", "exampleSetFlag":false }, "hasPostResponseData":{ "type":"boolean", "description":"Determines whether this risk has post-response values.", "exampleSetFlag":false, "types":[ "boolean" ] }, "identifiedDate":{ "type":"string", "description":"The date the risk was added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "riskType":{ "type":"string", "description":"The type of risk. Valid values are Threat, Opportunity, Weather and Risk Factor.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "THREAT", "OPPORTUNITY", "WEATHER", "RISK_FACTOR" ] }, "identifiedById":{ "type":"integer", "description":"The user who added the risk to the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "costImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified cost distribution is used to determine the cost impact for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualScheduleImpact":{ "type":"number", "description":"The actual schedule impact due to the risk occurring.", "format":"double", "exampleSetFlag":false }, "impactedDate":{ "type":"string", "description":"The date the risk impacted the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "locationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                          This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                          This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "effect":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The resulting effect of the presence of the risk.", "exampleSetFlag":false }, "ownerId":{ "type":"integer", "description":"The name of the user who is assigned to manage the risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "city":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ProgramRisk object, a unique ProgramRisk object can be identified by the following combinations of the fields.
                                                                                                                                                                                          • programRiskId
                                                                                                                                                                                          • riskCode,programId
                                                                                                                                                                                          • riskCode,programCode,workspaceCode
                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityProgramRiskQuantifiedCostImpactInput":{ "title":"ApiEntityProgramRiskQuantifiedCostImpactInput", "required":[ "preResponseDistributionShape", "programRiskId" ], "type":"object", "properties":{ "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "preResponseDistributionShape":{ "type":"string", "description":"Determines the distribution that best models the three-point estimates for the cost impact before a response. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "postResponseDistributionShape":{ "type":"string", "description":"Determines the distribution that best models the three-point estimates for the cost impact after a response.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "preResponseMinimum":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMinimumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikely":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMostLikelyProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preResponseMaximum":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMaximumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMinimum":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred. This field is in base currency and is calculated from postResponseMinimumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikely":{ "type":"number", "description":"The most likely cost of a risk event that has occurred. This field is in base currency and is calculated from postResponseMostLikelyProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMaximum":{ "type":"number", "description":"The maximum cost of responding to a risk event. This field is in base currency and is calculated from postResponseMaximumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "quantifiedCostImpactId":{ "type":"integer", "description":"The unique identifier of a cost impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskQuantifiedOtherImpactInput":{ "title":"ApiEntityProgramRiskQuantifiedOtherImpactInput", "required":[ "programRiskId", "quantifiedOtherImpactId", "shape" ], "type":"object", "properties":{ "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the program risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "shape":{ "type":"string", "description":"The distribution that best models the three-point estimates for risk probabilities or risk schedule impacts.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "minimum":{ "type":"number", "description":"The minimum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "maximum":{ "type":"number", "description":"The maximum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedOtherImpactId":{ "type":"integer", "description":"The unique identifier of a risk impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scoreType":{ "type":"string", "description":"The type of an impact score.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ] }, "mostLikely":{ "type":"number", "description":"The most likely probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "preOrPostResponse":{ "type":"string", "description":"Indicates whether a risk impact is measured pre or post response.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_RESPONSE", "POST_RESPONSE" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskMitigation":{ "title":"ApiEntityProgramRiskMitigation", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskMitigationCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskMitigationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskMitigationFinancial":{ "description":"The financial fields associated with a program risk mitigation.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramRiskMitigationFinancial" } ] }, "programRiskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary of the risk mitigation.", "exampleSetFlag":false }, "mitigationStatus":{ "type":"string", "description":"The status of the risk response action item.
                                                                                                                                                                                            Proposed: The response action has been proposed.
                                                                                                                                                                                            Sanctioned: The response action has been sanctioned.
                                                                                                                                                                                            Not Started: The response action has not started.
                                                                                                                                                                                            In Progress: The response action has started but has not been completed.
                                                                                                                                                                                            Completed: The response action has been completed.
                                                                                                                                                                                            Rejected: The response action has been rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "SANCTIONED", "NOT_STARTED", "REJECTED", "IN_PROGRESS", "COMPLETED" ] }, "activityAssigned":{ "type":"boolean", "description":"Indicates whether an activity is assigned to the response action.", "exampleSetFlag":false, "types":[ "boolean" ] }, "finishAfterExposure":{ "type":"string", "description":"Indicates whether the response action finishes after the start of exposure to the risk.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TRUE", "FALSE", "MISSING_DATES" ] }, "uniqueCode":{ "maxLength":128, "type":"string", "description":"A unique identifier for each Risk Mitigation per project that consists of the parent Risk Code followed by the Risk Mitigation Code.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinishDate":{ "type":"string", "description":"The latest scheduled finish date of all the risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedStartDate":{ "type":"string", "description":"The earliest scheduled start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The earliest start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The latest finish date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "timing":{ "type":"string", "description":"Indicates whether the response action start or finish is before today's date.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "STARTING_LATE", "FINISHING_LATE", "MISSING_DATES" ] }, "ownerId":{ "type":"integer", "description":"The name of the resource responsible for the risk response action item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskMitigationFinancial":{ "title":"ApiEntityProgramRiskMitigationFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "preResponseRemainingTotalCost":{ "type":"number", "description":"The response action Pre-Response Remaining Cost.", "format":"double", "exampleSetFlag":false }, "preResponseAtCompletionCost":{ "type":"number", "description":"The response action Pre-Response At Completion Cost.", "format":"double", "exampleSetFlag":false }, "postResponseRemainingTotalCost":{ "type":"number", "description":"The response action Post-Response Remaining Cost.", "format":"double", "exampleSetFlag":false }, "postResponseAtCompletionTotalCost":{ "type":"number", "description":"The response action Post-Response At Completion Cost.", "format":"double", "exampleSetFlag":false }, "programRiskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "preResponseActualCost":{ "type":"number", "description":"The response action Pre-Response Actual Cost.", "format":"double", "exampleSetFlag":false }, "postResponseActualCost":{ "type":"number", "description":"The response action Post-Response Actual Cost. ", "format":"double", "exampleSetFlag":false }, "actualCost":{ "type":"number", "description":"The response action Actual Cost.", "format":"double", "exampleSetFlag":false }, "remainingTotalCost":{ "type":"number", "description":"The response action Remaining Cost.", "format":"double", "exampleSetFlag":false }, "atCompletionTotalCost":{ "type":"number", "description":"The response action At Completion Cost.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskMitigationFinancialInput":{ "title":"ApiEntityProgramRiskMitigationFinancialInput", "type":"object", "properties":{ "programRiskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualCost":{ "type":"number", "description":"The response action Actual Cost.", "format":"double", "exampleSetFlag":false }, "remainingTotalCost":{ "type":"number", "description":"The response action Remaining Cost.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityProgramRiskMitigationInput":{ "title":"ApiEntityProgramRiskMitigationInput", "required":[ "programRiskId", "programRiskMitigationName" ], "type":"object", "properties":{ "programRiskMitigationCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskMitigationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskMitigationFinancial":{ "description":"The financial fields associated with a program risk mitigation.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProgramRiskMitigationFinancialInput" } ] }, "programRiskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary of the risk mitigation.", "exampleSetFlag":false }, "mitigationStatus":{ "type":"string", "description":"The status of the risk response action item.
                                                                                                                                                                                            Proposed: The response action has been proposed.
                                                                                                                                                                                            Sanctioned: The response action has been sanctioned.
                                                                                                                                                                                            Not Started: The response action has not started.
                                                                                                                                                                                            In Progress: The response action has started but has not been completed.
                                                                                                                                                                                            Completed: The response action has been completed.
                                                                                                                                                                                            Rejected: The response action has been rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "SANCTIONED", "NOT_STARTED", "REJECTED", "IN_PROGRESS", "COMPLETED" ] }, "plannedFinishDate":{ "type":"string", "description":"The latest scheduled finish date of all the risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedStartDate":{ "type":"string", "description":"The earliest scheduled start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The earliest start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The latest finish date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "ownerId":{ "type":"integer", "description":"The name of the resource responsible for the risk response action item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProgramRiskMitigation object, a unique ProgramRiskMitigation object can be identified by the following combinations of the fields.
                                                                                                                                                                                            • programRiskMitigationId
                                                                                                                                                                                            • programRiskMitigationCode,programRiskId
                                                                                                                                                                                            • programRiskMitigationCode,riskCode,programId
                                                                                                                                                                                            • programRiskMitigationCode,riskCode,programCode,workspaceCode
                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityProgramRiskWeatherPeriod":{ "title":"ApiEntityProgramRiskWeatherPeriod", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "programRiskWeatherPeriodId":{ "type":"integer", "description":"The system-generated identifier for the period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of a Risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the period.", "exampleSetFlag":false, "types":[ "string" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "shape":{ "type":"string", "description":"The probability distribution that best models the estimates for non-working days in the period. Valid values are Triangle and Uniform. If the value is Uniform, the required fields are minimum and maximum non-working days. If the value is Triangle, the required fields are minimum, maximum, and most-likely non-working days.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "mostLikelyNonWorkingDays":{ "type":"integer", "description":"The most likely number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "nonWorkingDaysPercentage":{ "type":"number", "description":"The percentage of non-working days in the period.", "format":"double", "exampleSetFlag":false }, "nonWorkingTimeDefinitionType":{ "type":"string", "description":"The method used to define the weather risk's non-working time. Valid values are Percentage and Distribution. If the value is Percentage, the required fields are non-working persistence and non-working days percentage. If the value is Distribution, the required fields are shape, minimum non-working days, most-likely non-working days, and maximum non-working days.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PERCENTAGE", "DISTRIBUTION" ] }, "periodStart":{ "type":"string", "description":"The start date of the period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "periodFinish":{ "type":"string", "description":"The finish date of the period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "minNonWorkingDays":{ "type":"integer", "description":"The minimum number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "maxNonWorkingDays":{ "type":"integer", "description":"The maximum number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "nonWorkingPersistence":{ "type":"number", "description":"The probability of a non-working day following another non-working day in the period.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProgramRiskWeatherPeriodInput":{ "title":"ApiEntityProgramRiskWeatherPeriodInput", "required":[ "nonWorkingTimeDefinitionType", "periodFinish", "periodName", "periodStart", "programRiskId" ], "type":"object", "properties":{ "programRiskWeatherPeriodId":{ "type":"integer", "description":"The system-generated identifier for the period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programRiskId":{ "type":"integer", "description":"The system-generated identifier of a Risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the period.", "exampleSetFlag":false, "types":[ "string" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "shape":{ "type":"string", "description":"The probability distribution that best models the estimates for non-working days in the period. Valid values are Triangle and Uniform. If the value is Uniform, the required fields are minimum and maximum non-working days. If the value is Triangle, the required fields are minimum, maximum, and most-likely non-working days.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "mostLikelyNonWorkingDays":{ "type":"integer", "description":"The most likely number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "nonWorkingDaysPercentage":{ "type":"number", "description":"The percentage of non-working days in the period.", "format":"double", "exampleSetFlag":false }, "nonWorkingTimeDefinitionType":{ "type":"string", "description":"The method used to define the weather risk's non-working time. Valid values are Percentage and Distribution. If the value is Percentage, the required fields are non-working persistence and non-working days percentage. If the value is Distribution, the required fields are shape, minimum non-working days, most-likely non-working days, and maximum non-working days.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PERCENTAGE", "DISTRIBUTION" ] }, "periodStart":{ "type":"string", "description":"The start date of the period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "periodFinish":{ "type":"string", "description":"The finish date of the period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "minNonWorkingDays":{ "type":"integer", "description":"The minimum number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "maxNonWorkingDays":{ "type":"integer", "description":"The maximum number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "nonWorkingPersistence":{ "type":"number", "description":"The probability of a non-working day following another non-working day in the period.", "format":"double", "exampleSetFlag":false } }, "description":"This entity represents a ProgramRiskWeatherPeriod object, a unique ProgramRiskWeatherPeriod object can be identified by the following combinations of the fields.
                                                                                                                                                                                              • programRiskWeatherPeriodId
                                                                                                                                                                                              • periodName,programRiskId
                                                                                                                                                                                              • periodName,riskCode,programId
                                                                                                                                                                                              • periodName,riskCode,programCode,workspaceCode
                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityProjectActuals":{ "title":"ApiEntityProjectActuals", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The user-specified identifier of a currency.", "exampleSetFlag":false, "types":[ "string" ] }, "withdrawConfirmedByEmailAddress":{ "maxLength":255, "type":"string", "description":"Indicates whether or not the actual withdrawl has been confirmed via email.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "totalHours":{ "type":"number", "description":"Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative.", "format":"double", "exampleSetFlag":false }, "projectActualsCost":{ "description":"An object containing cost fields in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActualsCost" } ] }, "withdrawByUserId":{ "type":"integer", "description":"The system-generated identifier of the user who withdrew confirmation of the project actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approvedByUserId":{ "type":"integer", "description":"The username of the user who approved the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approvedDate":{ "type":"string", "description":"The date that the actual was approved.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "withdrawDate":{ "type":"string", "description":"The date that confirmation of the project actual was withdrawn.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for an actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "confirmedByEmailAddress":{ "maxLength":255, "type":"string", "description":"Indicates whether or not the project actual has been confirmed via email.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the actual.", "exampleSetFlag":false, "types":[ "string" ] }, "companySourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of company data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "fixedExchangeRate":{ "type":"number", "description":"The exchange rate used to convert the Total Amount value from the record currency to the base currency.", "exampleSetFlag":false, "types":[ "number" ] }, "effectiveDate":{ "type":"string", "description":"The date the actual is effective.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details about the project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The name of the company associated with the actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a company.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyId":{ "type":"integer", "description":"The system-generated identifier of the currency associated with the project actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual data in an external source.", "example":"coarse", "exampleSetFlag":true, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project actuals.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"That status of the actual. Valid values are Pending and Confirmed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "CONFIRMED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectActualsConfiguredFieldValue":{ "title":"ApiEntityProjectActualsConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Project Actuals Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsId":{ "type":"integer", "description":"The system-generated identifier for an Actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costValueProject":{ "type":"number", "description":"This holds value of Cost type configured fields in the project level currency conversion. Input should be provided in numberValue field, in project actuals record level currency.", "format":"double", "exampleSetFlag":false }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectActualsCost":{ "title":"ApiEntityProjectActualsCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "totalAmountProjectActuals":{ "type":"number", "description":"The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the record level currency.", "format":"double", "exampleSetFlag":false }, "totalAmount":{ "type":"number", "description":"Total Amount is calculated as the sum of the Amount of each actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalAmountProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "totalAmountProject":{ "type":"number", "description":"The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "totalAmountWorkspace1":{ "type":"number", "description":"The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalAmountWorkspace2":{ "type":"number", "description":"The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalAmountWorkspace3":{ "type":"number", "description":"The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "projectActualsId":{ "type":"integer", "description":"The unique identifier of project actual data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActuals":{ "description":"The supporting details for the project actuals. ", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActuals" } ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectActualsConfiguredFieldValueInput":{ "title":"ApiEntityProjectActualsConfiguredFieldValueInput", "type":"object", "properties":{ "projectActualsConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Project Actuals Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsId":{ "type":"integer", "description":"The system-generated identifier for an Actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProjectActualsConfiguredFieldValue object, a unique ProjectActualsConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                • projectActualsConfiguredFieldValueId
                                                                                                                                                                                                • columnDefinitionId
                                                                                                                                                                                                • columnName
                                                                                                                                                                                                • columnLabel
                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityProjectActualsCostInput":{ "title":"ApiEntityProjectActualsCostInput", "type":"object", "properties":{ "projectActualsId":{ "type":"integer", "description":"The unique identifier of project actual data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActuals":{ "description":"The supporting details for the project actuals. ", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActualsInput" } ] } }, "exampleSetFlag":false }, "ApiEntityProjectActualsInput":{ "title":"ApiEntityProjectActualsInput", "required":[ "projectActualName", "projectId" ], "type":"object", "properties":{ "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The user-specified identifier of a currency.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsCost":{ "description":"Deprecated. As of 25.8.
                                                                                                                                                                                                  An object containing cost fields in the form of key-value pairs.", "deprecated":true, "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActualsCostInput" } ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for an actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the actual.", "exampleSetFlag":false, "types":[ "string" ] }, "companySourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of company data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "fixedExchangeRate":{ "type":"number", "description":"The exchange rate used to convert the Total Amount value from the record currency to the base currency.", "exampleSetFlag":false, "types":[ "number" ] }, "effectiveDate":{ "type":"string", "description":"The date the actual is effective.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details about the project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The name of the company associated with the actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a company.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyId":{ "type":"integer", "description":"The system-generated identifier of the currency associated with the project actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual data in an external source.", "example":"coarse", "exampleSetFlag":true, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project actuals.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"That status of the actual. Valid values are Pending and Confirmed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "CONFIRMED" ] } }, "description":"This entity represents a ProjectActuals object, a unique ProjectActuals object can be identified by the following combinations of the fields.
                                                                                                                                                                                                  • projectActualsId
                                                                                                                                                                                                  • projectActualsCode,projectId
                                                                                                                                                                                                  • projectActualsCode,projectCode,workspaceCode
                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityExternallySourcedProjectActuals":{ "title":"ApiEntityExternallySourcedProjectActuals", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The user-specified identifier of a currency.", "exampleSetFlag":false, "types":[ "string" ] }, "withdrawConfirmedByEmailAddress":{ "maxLength":255, "type":"string", "description":"Indicates whether or not the actual withdrawl has been confirmed via email.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "totalHours":{ "type":"number", "description":"Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative.", "format":"double", "exampleSetFlag":false }, "projectActualsCost":{ "description":"An object containing cost fields in the form of key-value pairs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActualsCost" } ] }, "withdrawByUserId":{ "type":"integer", "description":"The system-generated identifier of the user who withdrew confirmation of the project actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approvedByUserId":{ "type":"integer", "description":"The username of the user who approved the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approvedDate":{ "type":"string", "description":"The date that the actual was approved.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "withdrawDate":{ "type":"string", "description":"The date that confirmation of the project actual was withdrawn.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for an actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "confirmedByEmailAddress":{ "maxLength":255, "type":"string", "description":"Indicates whether or not the project actual has been confirmed via email.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the actual.", "exampleSetFlag":false, "types":[ "string" ] }, "companySourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of company data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "fixedExchangeRate":{ "type":"number", "description":"The exchange rate used to convert the Total Amount value from the record currency to the base currency.", "exampleSetFlag":false, "types":[ "number" ] }, "effectiveDate":{ "type":"string", "description":"The date the actual is effective.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details about the project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The name of the company associated with the actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a company.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyId":{ "type":"integer", "description":"The system-generated identifier of the currency associated with the project actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual data in an external source.", "example":"coarse", "exampleSetFlag":true, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project actuals.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"That status of the actual. Valid values are Pending and Confirmed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "CONFIRMED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedProjectActualsInput":{ "title":"ApiEntityExternallySourcedProjectActualsInput", "required":[ "projectActualName", "projectId" ], "type":"object", "properties":{ "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The user-specified identifier of a currency.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsCost":{ "description":"Deprecated. As of 25.8.
                                                                                                                                                                                                    An object containing cost fields in the form of key-value pairs.", "deprecated":true, "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActualsCostInput" } ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for an actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the actual.", "exampleSetFlag":false, "types":[ "string" ] }, "companySourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of company data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "fixedExchangeRate":{ "type":"number", "description":"The exchange rate used to convert the Total Amount value from the record currency to the base currency.", "exampleSetFlag":false, "types":[ "number" ] }, "effectiveDate":{ "type":"string", "description":"The date the actual is effective.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details about the project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The name of the company associated with the actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of a company.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyId":{ "type":"integer", "description":"The system-generated identifier of the currency associated with the project actual.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual data in an external source.", "example":"coarse", "exampleSetFlag":true, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project actuals.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"That status of the actual. Valid values are Pending and Confirmed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "CONFIRMED" ] } }, "description":"This entity represents a ExternallySourcedProjectActuals object, a unique ExternallySourcedProjectActuals object can be identified by the following combinations of the fields.
                                                                                                                                                                                                    • projectActualsId
                                                                                                                                                                                                    • projectActualsCode,projectId
                                                                                                                                                                                                    • projectActualsCode,projectCode,workspaceCode
                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityProjectActualsLineItem":{ "title":"ApiEntityProjectActualsLineItem", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "hours":{ "type":"number", "description":"The number of hours needed to complete the actual line item.", "format":"double", "exampleSetFlag":false }, "projectActualsLineItemId":{ "type":"integer", "description":"The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsLineItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for an actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsLineItemCost":{ "description":"The cost fields associated with a line item.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemCost" } ] }, "costCategoryAbbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "lineItemType":{ "type":"string", "description":"The type assigned to an actual line item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LUMP_SUM", "UNIT_PRICE" ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "cbsCodeSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of CBS data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "unitOfMeasureValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"The value of a units of measure.", "exampleSetFlag":false, "types":[ "string" ] }, "itemSuffix":{ "type":"integer", "description":"Auto numbering suffix of a project actuals line item code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category associated with the project actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual line item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of cost category associated with the project actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The CBS code assigned to the actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The quantity of the actual line item.
                                                                                                                                                                                                      If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered.
                                                                                                                                                                                                      If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectActualsLineItemCost":{ "title":"ApiEntityProjectActualsLineItemCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsLineItemId":{ "type":"integer", "description":"The system-generated identifier of a project actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "totalProject":{ "type":"number", "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "totalProjectActuals":{ "type":"number", "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the record level currency.", "format":"double", "exampleSetFlag":false }, "unitPrice":{ "type":"number", "description":"The price associated with the actual line item.
                                                                                                                                                                                                      If a Unit of Measure is associated with the actual line item, the Unit Price is the unit price per measure. This field is in base currency and is calculated from unitPriceProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "unitPriceProject":{ "type":"number", "description":"The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unitPriceWorkspace1":{ "type":"number", "description":"The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unitPriceWorkspace2":{ "type":"number", "description":"The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unitPriceWorkspace3":{ "type":"number", "description":"The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "unitPriceProjectActuals":{ "type":"number", "description":"The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the record level currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace1":{ "type":"number", "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace2":{ "type":"number", "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace3":{ "type":"number", "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "total":{ "type":"number", "description":"The cost amount associated with the actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectActualsLineItemCostInput":{ "title":"ApiEntityProjectActualsLineItemCostInput", "required":[ "totalProjectActuals" ], "type":"object", "properties":{ "projectActualsLineItemId":{ "type":"integer", "description":"The system-generated identifier of a project actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "totalProjectActuals":{ "type":"number", "description":"The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the record level currency.", "format":"double", "exampleSetFlag":false }, "unitPriceProjectActuals":{ "type":"number", "description":"The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the record level currency.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityProjectActualsLineItemInput":{ "title":"ApiEntityProjectActualsLineItemInput", "required":[ "name", "projectActualsId", "projectActualsLineItemCost" ], "type":"object", "properties":{ "name":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "hours":{ "type":"number", "description":"The number of hours needed to complete the actual line item.", "format":"double", "exampleSetFlag":false }, "projectActualsLineItemId":{ "type":"integer", "description":"The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsLineItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for an actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsLineItemCost":{ "description":"The cost fields associated with a line item.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemCostInput" } ] }, "costCategoryAbbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "lineItemType":{ "type":"string", "description":"The type assigned to an actual line item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LUMP_SUM", "UNIT_PRICE" ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "cbsCodeSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of CBS data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "unitOfMeasureValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"The value of a units of measure.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category associated with the project actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual line item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of cost category associated with the project actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The CBS code assigned to the actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The quantity of the actual line item.
                                                                                                                                                                                                      If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered.
                                                                                                                                                                                                      If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure.", "format":"double", "exampleSetFlag":false } }, "description":"This entity represents a ProjectActualsLineItem object, a unique ProjectActualsLineItem object can be identified by the following combinations of the fields.
                                                                                                                                                                                                      • projectActualsLineItemId
                                                                                                                                                                                                      • projectActualsLineItemCode,projectActualsId
                                                                                                                                                                                                      • projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode
                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityExternallySourcedProjectActualsLineItem":{ "title":"ApiEntityExternallySourcedProjectActualsLineItem", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "hours":{ "type":"number", "description":"The number of hours needed to complete the actual line item.", "format":"double", "exampleSetFlag":false }, "projectActualsLineItemId":{ "type":"integer", "description":"The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsLineItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for an actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsLineItemCost":{ "description":"The cost fields associated with a line item.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemCost" } ] }, "costCategoryAbbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "lineItemType":{ "type":"string", "description":"The type assigned to an actual line item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LUMP_SUM", "UNIT_PRICE" ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "cbsCodeSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of CBS data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "unitOfMeasureValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"The value of a units of measure.", "exampleSetFlag":false, "types":[ "string" ] }, "itemSuffix":{ "type":"integer", "description":"Auto numbering suffix of a project actuals line item code.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category associated with the project actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual line item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of cost category associated with the project actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The CBS code assigned to the actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The quantity of the actual line item.
                                                                                                                                                                                                        If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered.
                                                                                                                                                                                                        If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedProjectActualsLineItemInput":{ "title":"ApiEntityExternallySourcedProjectActualsLineItemInput", "required":[ "name", "projectActualsId", "projectActualsLineItemCost" ], "type":"object", "properties":{ "name":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "hours":{ "type":"number", "description":"The number of hours needed to complete the actual line item.", "format":"double", "exampleSetFlag":false }, "projectActualsLineItemId":{ "type":"integer", "description":"The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectActualsLineItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for an actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsLineItemCost":{ "description":"The cost fields associated with a line item.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectActualsLineItemCostInput" } ] }, "costCategoryAbbreviation":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviated name of a cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsId":{ "type":"integer", "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "lineItemType":{ "type":"string", "description":"The type assigned to an actual line item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LUMP_SUM", "UNIT_PRICE" ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "projectActualsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project actual.", "exampleSetFlag":false, "types":[ "string" ] }, "projectActualsSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "cbsCodeSourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of CBS data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "unitOfMeasureValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"The value of a units of measure.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category associated with the project actual line item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of project actual line item data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of cost category associated with the project actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The CBS code assigned to the actual line item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "quantity":{ "type":"number", "description":"The quantity of the actual line item.
                                                                                                                                                                                                        If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered.
                                                                                                                                                                                                        If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure.", "format":"double", "exampleSetFlag":false } }, "description":"This entity represents a ExternallySourcedProjectActualsLineItem object, a unique ExternallySourcedProjectActualsLineItem object can be identified by the following combinations of the fields.
                                                                                                                                                                                                        • projectActualsLineItemId
                                                                                                                                                                                                        • projectActualsLineItemCode,projectActualsId
                                                                                                                                                                                                        • projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode
                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityProjectUserPermissionsResponse":{ "title":"ApiEntityProjectUserPermissionsResponse", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"Profiles response with individual message and statusCodes.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfileResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProjectProfileInput":{ "title":"ApiEntityProjectProfileInput", "type":"object", "properties":{ "projectProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the project profile.", "exampleSetFlag":false, "types":[ "string" ] }, "fileProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the document profile.", "exampleSetFlag":false, "types":[ "string" ] }, "reportProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the report profile.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the custom log profile.", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectUserPermissions":{ "title":"ApiEntityProjectUserPermissions", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProjectUserGroupPermissionInput":{ "title":"ApiEntityProjectUserGroupPermissionInput", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectUserGroupProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProjectUserGroupProfileInput":{ "title":"ApiEntityProjectUserGroupProfileInput", "type":"object", "properties":{ "userGroupId":{ "type":"string", "description":"System-defined identifier of the user group.", "exampleSetFlag":false, "types":[ "string" ] }, "projectProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the project profile.", "exampleSetFlag":false, "types":[ "string" ] }, "fileProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the document profile.", "exampleSetFlag":false, "types":[ "string" ] }, "reportProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the report profile.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the custom log profile.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectUserGroupAssignmentInput":{ "title":"ApiEntityProjectUserGroupAssignmentInput", "type":"object", "properties":{ "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userNames":{ "type":"array", "description":"List of usernames of the users for user group assignment.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "userGroupId":{ "type":"integer", "description":"System-defined identifier of the user group.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueProjectInput":{ "title":"ApiEntityCodeValueProjectInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueProjectId":{ "type":"integer", "description":"The unique identifier of the workspace where the code value was created. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueProject object, a unique CodeValueProject object can be identified by the following combinations of the fields.
                                                                                                                                                                                                          • codeValueProjectId
                                                                                                                                                                                                          • codeValueId
                                                                                                                                                                                                          • codeTypeId,codeValueCode
                                                                                                                                                                                                          • codeTypeCode,codeValueCode
                                                                                                                                                                                                          • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                          • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                          • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                          • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                          • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                          • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityProjectCashFlowInput":{ "title":"ApiEntityProjectCashFlowInput", "type":"object", "properties":{ "year":{ "type":"integer", "description":"The time period during which budget planning for the project takes place in years.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "month":{ "type":"integer", "description":"The time period during which budget planning for the project takes place in months.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "forecastCapitalCostProject":{ "type":"number", "description":"The time phased estimation of a project's remaining capital costs.
                                                                                                                                                                                                            After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                                                                                                                                            Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostProject":{ "type":"number", "description":"The time phased estimation of a project's remaining expense costs.
                                                                                                                                                                                                            After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                                                                                                                                            Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostProject":{ "type":"number", "description":"The time phased actual capital spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                                                            Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostProject":{ "type":"number", "description":"The time phased actual expense spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                                                            Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalProject":{ "type":"number", "description":"The planned time phased capital cost in project currency of a project as defined by the project manager.
                                                                                                                                                                                                            Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                                                                                                                                            Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseProject":{ "type":"number", "description":"The planned time phased expense cost in project currency of a project as defined by the project manager.
                                                                                                                                                                                                            Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                                                                                                                                            Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsProject":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "projectPhaseFinancialId":{ "type":"integer", "description":"The unique internal identifier for the project's time-phased cost spread. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "spreadDate":{ "type":"string", "description":"The starting date for a time phase of the project life cycle.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastCostProject":{ "type":"number", "description":"The time phased estimation of a project's remaining costs.
                                                                                                                                                                                                            After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.
                                                                                                                                                                                                            Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetProject":{ "type":"number", "description":"The planned time phased cost in project currency of a project as defined by the project manager.
                                                                                                                                                                                                            Project managers can control the time phased allocations of a project's Planned Budget giving planner a sense of when the highest costs may be accrued on the project.
                                                                                                                                                                                                            Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "spendCostProject":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                                                            Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProjectCashFlow object, a unique ProjectCashFlow object can be identified by the following combinations of the fields.
                                                                                                                                                                                                            • projectPhaseFinancialId
                                                                                                                                                                                                            • month,year,projectId
                                                                                                                                                                                                            • month,year,projectCode,workspaceCode
                                                                                                                                                                                                            • spreadDate,projectId
                                                                                                                                                                                                            • spreadDate,projectCode,workspaceCode
                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityProjectConfiguredFieldValueInput":{ "title":"ApiEntityProjectConfiguredFieldValueInput", "type":"object", "properties":{ "projectConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Project Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier for an Project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProjectConfiguredFieldValue object, a unique ProjectConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                              • projectConfiguredFieldValueId
                                                                                                                                                                                                              • columnDefinitionId
                                                                                                                                                                                                              • columnName
                                                                                                                                                                                                              • columnLabel
                                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityProjectFinancialInput":{ "title":"ApiEntityProjectFinancialInput", "type":"object", "properties":{ "estAtCompleteCostProject":{ "type":"number", "description":"The expected total cost of the project when the defined scope of work will be completed.
                                                                                                                                                                                                                This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "estToCompleteCostProject":{ "type":"number", "description":"The estimated cost needed to complete the project.
                                                                                                                                                                                                                This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCapitalCostProject":{ "type":"number", "description":"The total capital estimation of a project's remaining costs.
                                                                                                                                                                                                                Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastExpenseCostProject":{ "type":"number", "description":"The total expense estimation of a project's remaining costs.
                                                                                                                                                                                                                Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCapitalCostProject":{ "type":"number", "description":"Total capital costs accrued on a project within a given time period.
                                                                                                                                                                                                                The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                                                                                                                                                Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualExpenseCostProject":{ "type":"number", "description":"Total expense costs accrued on a project within a given time period.
                                                                                                                                                                                                                The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                                                                                                                                                Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetCapitalProject":{ "type":"number", "description":"The planned total capital cost of a project as defined by the project manager.
                                                                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetExpenseProject":{ "type":"number", "description":"The planned total expense cost of a project as defined by the project manager.
                                                                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "constructionValueProject":{ "minimum":0, "type":"number", "description":"Construction Value is the total of all project-related costs incurred by the constructing company (usually a General Contractor) over the period of construction. This would generally include cost of materials, subcontract totals, overhead costs, general conditions and tax. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "benefitsProject":{ "type":"number", "description":"Project benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCostProject":{ "type":"number", "description":"Total costs accrued on a project within a given time period.
                                                                                                                                                                                                                The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule.
                                                                                                                                                                                                                Actual Cost data is only available when the application is connected with P6 EPPM and is not editable. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "earnedValueCostProject":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.
                                                                                                                                                                                                                The cost value used for the Earned Value Management of a project.
                                                                                                                                                                                                                Earned Value Management allows project managers to quantify project progress and objectively measure a project's success.
                                                                                                                                                                                                                This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostProject":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a project.
                                                                                                                                                                                                                Planned Value Cost is often used for Earned Value Management.
                                                                                                                                                                                                                This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "scheduleVarianceProject":{ "type":"number", "description":"The measure of schedule performance on a project.
                                                                                                                                                                                                                A negative value indicates that less work was actually performed than was scheduled.
                                                                                                                                                                                                                This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "forecastCostProject":{ "type":"number", "description":"The total estimation of a project's remaining costs.
                                                                                                                                                                                                                Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedBudgetProject":{ "type":"number", "description":"The planned total cost of a project as defined by the project manager.
                                                                                                                                                                                                                Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to projects, as well as what projects are reasonable to include in the current portfolio budget plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "spendCostProject":{ "type":"number", "description":"The total amount incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals.
                                                                                                                                                                                                                Actuals cannot be edited if a project has a status of Proposal. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "costPerfIndex":{ "type":"number", "description":"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.
                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "schedPerfIndex":{ "type":"number", "description":"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.
                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "paybackPeriod":{ "type":"number", "description":"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.


                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "profitabilityIndex":{ "type":"number", "description":"The index based on the value of a project's present values divided by initial project investments.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "annualDiscountRate":{ "maximum":1, "minimum":0, "type":"number", "description":"The interest rate associated with the cost of an investment from your commercial bank or another funding source.
                                                                                                                                                                                                                For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value.
                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "netPresentValueProject":{ "type":"number", "description":"The difference between the present value (PV) of the future cash flows from current investments and project costs.
                                                                                                                                                                                                                The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
                                                                                                                                                                                                                Positive Net Present Value (NPV) is an indicator of projects that should be pursued.
                                                                                                                                                                                                                This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "returnInvestment":{ "type":"number", "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a project or portfolio.
                                                                                                                                                                                                                For example, a project is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%.
                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "costVarianceProject":{ "type":"number", "description":"The measure of cost performance on a project.
                                                                                                                                                                                                                A negative value indicates that the Actual Cost has exceeded the planned value.
                                                                                                                                                                                                                This value can be entered manually or can be imported. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "intRateReturn":{ "type":"number", "description":"The quantitative measurement used to compare the profitability of project investments.
                                                                                                                                                                                                                The rate at which investors will receive returns on their investments in a project.
                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The remaining total cost for the project, including labor resources, nonlabor resources, and project expenses when the project is summarized.
                                                                                                                                                                                                                This value can be imported and integrated.
                                                                                                                                                                                                                The value for remaining Cost cannot be entered/edited manually through UI.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier for a project set by the user who created the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "project":{ "description":"Project object of project financial.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProject" } ] } }, "exampleSetFlag":false }, "ApiEntityProjectInput":{ "title":"ApiEntityProjectInput", "required":[ "dataDate", "planStartDate", "projectCode", "projectName", "workspaceId" ], "type":"object", "properties":{ "breakdownCapitalForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectIntegrationSourceDetails":{ "description":"The integration source details associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectIntegrationSourceInput" } ] }, "copyFromProjectId":{ "type":"integer", "description":"The system-generated unique identifier of the project or project template from which the new project needs to be copied from.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "copyCustomLogTypes":{ "type":"array", "description":"Name of custom log types from the project or project template to be copied to create a new project.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "codeValuesProject":{ "type":"array", "description":"The list of code values for a project. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectFinancial":{ "description":"The financial fields associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectFinancialInput" } ] }, "copyOptions":{ "type":"object", "description":"

                                                                                                                                                                                                                The copy options map controls which features are copied when creating a new project from an existing project or project template. Each entry uses a feature name as the key and a boolean value (true or false) to determine whether the corresponding feature is included in the new project. Features not specified or explicitly set to false are excluded from the copy operation.

                                                                                                                                                                                                                \nMap Keys (Allowed Values):\n
                                                                                                                                                                                                                  \n
                                                                                                                                                                                                                • ACTIVITY
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • RELATIONSHIP
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • RESOURCE
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • ROLE
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • ASSIGNMENT
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • TASK
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • TASK_HANDOFFS
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • RISK
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • MATRIX
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • ACTIVITY_UNCERTAINTY
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • WBS
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • AUTO_NUMBERING
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • MANAGER
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • PROJECT_SETTINGS
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • CALENDAR
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • UOM
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • MONTECARLO_SETTING
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • CUSTOM_LOG
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • PROJECT_CODE
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • PROJECT_CALENDAR
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • COPY_ACTUALS
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                \nExample:\n
                                                                                                                                                                                                                { \"ACTIVITY\": true, \"RESOURCE\": true }
                                                                                                                                                                                                                \n

                                                                                                                                                                                                                Note: To copy either \"RESOURCE\" or \"ROLE\", both options must be set to true.

                                                                                                                                                                                                                \n
                                                                                                                                                                                                                \nCOPY_ACTUALS Option and Group Dependencies\n

                                                                                                                                                                                                                The COPY_ACTUALS option enables copying of actuals data (project progress data) for supported features. When COPY_ACTUALS is set to true, certain features are grouped together for dependency management.

                                                                                                                                                                                                                \nFeature groups:\n
                                                                                                                                                                                                                  \n
                                                                                                                                                                                                                • Schedule Actuals Group: ACTIVITY, RELATIONSHIP, ASSIGNMENT
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • Resource Actuals Group: RESOURCE, ROLE
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • Risk Actuals Group: RISK, MATRIX, ACTIVITY_UNCERTAINTY
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • Task Actuals Group: TASK, TASK_HANDOFFS
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                \nDependency rules when COPY_ACTUALS is true:\n
                                                                                                                                                                                                                  \n
                                                                                                                                                                                                                • If any member of a group is included and COPY_ACTUALS is true, all features in that group are automatically set to true by the system, regardless of whether they were specified or set to false in the input map.
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • Inclusion of any feature within the Risk Actuals Group results in all members of the Schedule Actuals Group also being copied, ensuring consistency and completeness of the actuals data.
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                \nExamples:\n
                                                                                                                                                                                                                  \n
                                                                                                                                                                                                                • With { \"TASK\": true, \"COPY_ACTUALS\": true }, both TASK and TASK_HANDOFFS will be copied.
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                • With { \"RISK\": true, \"COPY_ACTUALS\": true }, the following features will be copied: RISK, MATRIX, ACTIVITY_UNCERTAINTY, ACTIVITY, RELATIONSHIP, and ASSIGNMENT.
                                                                                                                                                                                                                  • \n
                                                                                                                                                                                                                \n

                                                                                                                                                                                                                When COPY_ACTUALS is not enabled, only the features explicitly set to true are copied, and no automatic group expansion occurs.

                                                                                                                                                                                                                ", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_RESOURCE_DOCUMENT_KEY:project_resource_copyOptions_description" } }, "priorityNum":{ "maximum":10000, "minimum":1, "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "primaryProgramCode":{ "maxLength":60, "type":"string", "description":"The user-defined identifier of a primary program of a project. This field is intended to be used while updating a project.
                                                                                                                                                                                                                The value of this field cannot be removed by providing the value as null in the payload. Instead, use the primaryProgramId field with the value null to remove the value from this field.", "exampleSetFlag":false, "types":[ "string" ] }, "projectName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The Actual Start indicates the date work on the project began.
                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The Actual Finish displays the date on which a project is considered complete.
                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastFinishDate":{ "type":"string", "description":"The planned finish date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastStartDate":{ "type":"string", "description":"The planned start date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendStartDate":{ "type":"string", "description":"The start date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendFinishDate":{ "type":"string", "description":"The finish date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsStartDate":{ "type":"string", "description":"The date benefits on the project began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsFinishDate":{ "type":"string", "description":"The date benefits on the project finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendEffectiveDate":{ "type":"string", "description":"The month in which an actuals value was last added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastToSpend":{ "type":"boolean", "description":"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.", "exampleSetFlag":false, "types":[ "boolean" ] }, "forecastLinkType":{ "type":"string", "description":"The type of forecast data linked to a project. Forecast data represents an estimation of a project's remaining costs.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "INTEGRATION" ] }, "plannedBudgetLinkType":{ "type":"string", "description":"Type of data to which a project's planned budget is linked.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "BUDGET", "INTEGRATION" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The estimated percentage of work that has been completed on the project. This value is entered by the user.", "format":"double", "exampleSetFlag":false }, "riskMatrixId":{ "type":"integer", "description":"The risk matrix assigned to the project for calculating project risk scores.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reportCycleId":{ "type":"integer", "description":"The reporting cycle assigned to the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCashFlows":{ "type":"array", "description":"The cash flow of a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCashFlowInput", "exampleSetFlag":false }, "types":[ "array" ] }, "primaryProgramId":{ "type":"integer", "description":"The system-generated identifier of a primary program of a project. This field is intended to be used while updating a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualLinkType":{ "type":"string", "description":"Type of actuals data linked to a project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "ACTUAL", "INTEGRATION" ] }, "projectSettings":{ "type":"array", "description":"The project settings associated with the project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectSettingInput", "exampleSetFlag":false }, "types":[ "array" ] }, "planEndDate":{ "type":"string", "description":"The finish date for the time phased Planned Budget of the project.
                                                                                                                                                                                                                Planned Budget cost spread will adjust when this date is changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planStartDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "websiteUrl":{ "maxLength":200, "minLength":0, "type":"string", "description":"The link to a website related to the project.", "exampleSetFlag":false, "types":[ "string" ] }, "dataDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "strgyPriorityNum":{ "maximum":10000, "minimum":1, "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "mustFinishByDate":{ "type":"string", "description":"The latest date on which the scheduled activities must be complete for a project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastTo":{ "type":"integer", "description":"Specifies data to which a project forecast is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linkActualTo":{ "type":"integer", "description":"Specifies data to which project actuals data is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isTemplateFlag":{ "type":"boolean", "description":"Indicates the project is a template for creating other projects.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exchangeRate":{ "type":"number", "description":"The custom exchange rate for the currency assigned to the project.", "exampleSetFlag":false, "types":[ "number" ] }, "projectIntegrationType":{ "type":"string", "description":"Specifies if the project is integrated with another application.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "P6", "UNIFIER" ] }, "riskLevel":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ] }, "riskScore":{ "type":"integer", "description":"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.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectTimeZone":{ "type":"string", "description":"The time zone of the project's location.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "INTERNATIONAL_DATE_LINE_WEST", "MIDWAY_ISLAND_SAMOA", "HAWAII", "ALASKA", "PACIFIC_TIME", "ARIZONA", "CHIHUAHUA_LA_PAZ_MAZATLAN", "MOUNTAIN_TIME", "CENTRAL_AMERICA", "CENTRAL_TIME", "GUADALAJARA_MEXICO_CITY_MONTERREY", "SASKATCHEWAN", "BOGOTA_LIMA_QUITO", "EASTERN_TIME", "INDIANA", "ATLANTIC_TIME", "CARACAS_LA_PAZ_PUERTO_RICO", "SANTIAGO", "NEWFOUNDLAND", "BRASILIA", "BUENOS_AIRES_GEORGETOWN", "MID_ATLANTIC", "AZORES", "CAPE_VERDE_IS", "CASABLANCA_MONROVIA", "GREENWICH_MEAN_TIME", "AMSTERDAM_BERLIN_BERN", "BELGRADE_BRATISLAVA_BUDAPEST", "BRUSSELS_COPENHAGEN_MADRID", "SARAJEVO_SKOPJE_WARSAW", "WEST_CENTRAL_AFRICA", "ATHENS_BEIRUT_ISTANBUL", "BUCHAREST", "CAIRO", "HARARE_PRETORIA", "HELSINKI_KVIV_RIGA", "JERUSALEM", "BAGHDAD", "KUWAIT_RIYADH", "NAIROBI", "MOSCOW_ST_PETERSBURG", "TEHRAN", "ABU_DHADI_MUSCAT", "BAKU_TBILISI_YEREVAN", "KABUL", "ISLAMABAD_KARACHI_TASHKENT", "CHENNAI_KOLKATA_MUMBAI", "ASTANA_DHAKA", "RANGOON", "BANGKOK_HANOI_JAKARTA", "BEJING_CHONGQING_HONG_KONG", "KUALA_LUMPUR_SINGAPORE", "PERTH", "TAIPEI", "OSAKA_SAPPORO_TOKYO", "SEOUL", "ADELAIDE", "DARWIN", "BRISBANE", "CANBERRA_MELBOURNE_SYDNEY", "GUAM_PORT_MORESBY", "HOBART", "MAGADAN_SOLOMON_IS_NEW_CALEDONIA", "AUCKLAND_WELLINGTON" ] }, "projectCurrency":{ "type":"integer", "description":"The unique identifier of the currency to be used in the project. Currencies configured in the immediate parent workspace, with at least one exchange rate configured, are available to be used in the project. If no value is specified, the parent workspace currency will be selected.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of appearance of projects in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "managerId":{ "type":"integer", "description":"The user id of a manager or person responsible for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of a project in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The date on which work on the project starts.
                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The date on which all project work is complete.
                                                                                                                                                                                                                This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "locationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "minLength":0, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manager":{ "maxLength":255, "type":"string", "description":"The user name of a manager or person responsible for the project.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETE" ] } }, "description":"This entity represents a Project object, a unique Project object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                • projectId
                                                                                                                                                                                                                • projectCode,workspaceId
                                                                                                                                                                                                                • projectCode,workspaceCode
                                                                                                                                                                                                                • projectCode,projectName,copyFromProjectId
                                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityProjectIntegrationSourceInput":{ "title":"ApiEntityProjectIntegrationSourceInput", "type":"object", "properties":{ "projectIntegrationSourceId":{ "type":"integer", "description":"The system-generated identifier of the project integration source. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceProjectName":{ "maxLength":255, "type":"string", "description":"The Project name of Integration source.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceProjectId":{ "maxLength":255, "type":"string", "description":"The Project identifier of Integration source.", "exampleSetFlag":false, "types":[ "string" ] }, "integrationSource":{ "type":"string", "description":"The source of Integration.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "P6", "UNIFIER" ] }, "lastIntegratedDate":{ "type":"string", "description":"The date of the last successful Integration.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier of the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityProjectSettingInput":{ "title":"ApiEntityProjectSettingInput", "required":[ "projectId", "settingName", "settingValue" ], "type":"object", "properties":{ "settingName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a project button.", "exampleSetFlag":false, "types":[ "string" ] }, "settingValue":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Value of a project setting.", "exampleSetFlag":false, "types":[ "string" ] }, "projectSettingId":{ "type":"integer", "description":"The unique identifier of a project setting. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedProject":{ "title":"ApiEntityExternallySourcedProject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "roleDemandCommitDuration":{ "type":"number", "description":"The total duration of committed demand resources.", "format":"double", "exampleSetFlag":false }, "roleDemandCommitStartDate":{ "type":"string", "description":"The start date for committed demand data.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectCurrencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The user-specified identifier of the project's assigned currency.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMatrixCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of the project's assigned risk matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "roleCommittedFte":{ "type":"number", "description":"The total committed FTE. Calculated as total commitment units divided by total commitment duration.", "exampleSetFlag":false, "types":[ "number" ] }, "roleDemandFte":{ "type":"number", "description":"The total demand FTE. Calculated as total demand units divided by total demand duration.", "exampleSetFlag":false, "types":[ "number" ] }, "roleDemandCommittedUnit":{ "type":"number", "description":"Indicates whether or not resources were committed for this demand.", "format":"double", "exampleSetFlag":false }, "roleDemandCommitEndDate":{ "type":"string", "description":"The finish date for committed demand data.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "roleDemandUnits":{ "type":"number", "description":"The demand units entered for a single role.", "format":"double", "exampleSetFlag":false }, "roleDemandDuration":{ "type":"number", "description":"The total expected duration of the weekly demand data.", "format":"double", "exampleSetFlag":false }, "roleDemandEndDate":{ "type":"string", "description":"The finish date for the weekly demand data. Calculated as Start plus Total Demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "roleDemandStartDate":{ "type":"string", "description":"The start date for weekly demand data.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's assigned calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "street":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                  This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "street2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                  This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "currentApprovedStartDate":{ "type":"string", "description":"The start date for the Current Approved Budget set by the budget planner.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "currentApprovedFinishDate":{ "type":"string", "description":"The finish date for the Current Approved Budget set by the budget planner.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "reportCycleNamingBoundary":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ] }, "noPredecessorActivityCount":{ "type":"integer", "description":"The number of activities in the project without predecessors.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "noSuccessorActivityCount":{ "type":"integer", "description":"The number of activities in the project without successors.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "danglingStartActivityCount":{ "type":"integer", "description":"The number of activities in the project that only have Start-to-Finish or Finish-to-Finish predecessor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Start-to-Start predecessor; No Start-to-Start successor; No Start-to-Finish successor; No Finish-to-Start predecessor. If the activity type is Milestone, the activity is not counted.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "danglingFinishActivityCount":{ "type":"integer", "description":"The number of activities in the project that only have Start-to-Finish or Start-to-Start successor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Finish-to-Finish predecessor; No Finish-to-Finish successor; No Start-to-Finish predecessor; No Finish-to-Start successor. If the activity type is Milestone, the activity is not counted.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "predecessorNegativeLagActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a lag less than 0.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "predecessorLagActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a lag greater than 0.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "fsPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Finish-to-Start (FS).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ssPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Start-to-Start (SS).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ffPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Finish-to-Finish (FF).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "sfPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Start-to-Finish (SF).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "hardConstraintActivityCount":{ "type":"integer", "description":"The number of activities in the project with a primary constraint of Mandatory Start or Mandatory Finish.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "softConstraintActivityCount":{ "type":"integer", "description":"The number of activities in the project with a primary constraint of As Late As Possible, Finish On, Finish On or After, Finish On or Before, Start On, Start On or After, or Start On or Before.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "negativeFloatActivityCount":{ "type":"integer", "description":"The number of activities in the project with a total float less than 0.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "largeDurationActivityCount":{ "type":"integer", "description":"The number of activities in the project with an Activity Remaining Duration that meets or exceeds the given criteria value. The default value is 320h.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "invalidProgressDateActivityCount":{ "type":"integer", "description":"The number of activities in the project with invalid progress. An activity is included in the count if any of the following are true: Activity Planned Start less than Data Date unless Activity has Actual Start; Activity Planned Finish less than or equal to Data Date and Activity is Not Started; Activity Actual Start greater than or equal to Data Date; Activity Actual Finish greater than Data Date.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "noPredecessorActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without predecessors.", "format":"double", "exampleSetFlag":false }, "noSuccessorActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without successors.", "format":"double", "exampleSetFlag":false }, "danglingStartActivityPercent":{ "type":"number", "description":"The percentage of activities in the project that only have Start-to-Finish or Finish-to-Finish predecessor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Start-to-Start predecessor; No Start-to-Start successor; No Start-to-Finish successor; No Finish-to-Start predecessor. If the activity type is Milestone, the activity is not counted.", "format":"double", "exampleSetFlag":false }, "danglingFinishActivityPercent":{ "type":"number", "description":"The percentage of activities in the project that only have Start-to-Finish or Start-to-Start successor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Finish-to-Finish predecessor; No Finish-to-Finish successor; No Start-to-Finish predecessor; No Finish-to-Start successor. If the activity type is Milestone, the activity is not counted.", "format":"double", "exampleSetFlag":false }, "predecessorNegativeLagActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a lag less than 0.", "format":"double", "exampleSetFlag":false }, "predecessorLagActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a lag greater than 0.", "format":"double", "exampleSetFlag":false }, "fsPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Finish-to-Start (FS).", "format":"double", "exampleSetFlag":false }, "ssPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Start-to-Start (SS).", "format":"double", "exampleSetFlag":false }, "ffPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Finish-to-Finish (FF).", "format":"double", "exampleSetFlag":false }, "sfPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Start-to-Finish (SF).", "format":"double", "exampleSetFlag":false }, "hardConstraintActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with a primary constraint of Mandatory Start or Mandatory Finish.", "format":"double", "exampleSetFlag":false }, "softConstraintActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with a primary constraint of As Late As Possible, Finish On, Finish On or After, Finish On or Before, Start On, Start On or After, or Start On or Before.", "format":"double", "exampleSetFlag":false }, "largeFloatActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with an Activity Total Float that meets or exceeds the given criteria value. The default value is 320h.", "format":"double", "exampleSetFlag":false }, "negativeFloatActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with a total float less than 0.", "format":"double", "exampleSetFlag":false }, "largeDurationActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with an Activity Remaining Duration that meets or exceeds the given criteria value. The default value is 320h.", "format":"double", "exampleSetFlag":false }, "noResourceActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without role or resource assignments.", "format":"double", "exampleSetFlag":false }, "invalidProgressDateActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with invalid progress. An activity is included in the count if any of the following are true: Activity Planned Start less than Data Date; Activity Planned Finish less than or equal to Data Date; Activity Actual Start greater than or equal to Data Date; Activity Actual Finish greater than Data Date.", "format":"double", "exampleSetFlag":false }, "projectScheduleHealthPercent":{ "type":"number", "description":"The weighted aggregation of active check values that represents the overall quality of your project. A higher schedule health score indicates a higher quality schedule. Calculated as 100% - (Sum of [Check Adjusted Percentage * Check Weighting] / Sum of all active check weighting values)", "format":"double", "exampleSetFlag":false }, "percentCompleteWeightedBy":{ "type":"string", "description":"The weight for scope items is calculated using quantity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COST", "QUANTITY", "HOURS", "MANUAL" ] }, "breakdownCapitalForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectIntegrationSourceDetails":{ "description":"The integration source details associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectIntegrationSource" } ] }, "lastProjectEvaluationDate":{ "type":"string", "description":"The date on which the project was last evaluated. ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "copyFromProjectId":{ "type":"integer", "description":"Deprecated. As of 26.1.
                                                                                                                                                                                                                  The system-generated unique identifier of the project or project template from which the new project needs to be copied from.", "format":"int64", "deprecated":true, "exampleSetFlag":false, "types":[ "integer" ] }, "copyCustomLogTypes":{ "type":"array", "description":"Name of custom log types from the project or project template to be copied to create a new project.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "codeValuesProject":{ "type":"array", "description":"The list of code values for a project. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProject", "exampleSetFlag":false }, "types":[ "array" ] }, "projectFinancial":{ "description":"The financial fields associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectFinancial" } ] }, "projectAutoNumber":{ "type":"array", "description":"The autonumber settings of a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectAutoNumber", "exampleSetFlag":false }, "types":[ "array" ] }, "projectTerm":{ "type":"string", "description":"Project termination date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "copyOptions":{ "type":"object", "description":"Deprecated. As of 26.1.

                                                                                                                                                                                                                  The copy options map controls which features are copied when creating a new project from an existing project or project template. Each entry uses a feature name as the key and a boolean value (true or false) to determine whether the corresponding feature is included in the new project. Features not specified or explicitly set to false are excluded from the copy operation.

                                                                                                                                                                                                                  \nMap Keys (Allowed Values):\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • ACTIVITY
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • RELATIONSHIP
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • RESOURCE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • ROLE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • ASSIGNMENT
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • TASK
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • TASK_HANDOFFS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • RISK
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • MATRIX
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • ACTIVITY_UNCERTAINTY
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • WBS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • AUTO_NUMBERING
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • MANAGER
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • PROJECT_SETTINGS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • CALENDAR
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • UOM
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • MONTECARLO_SETTING
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • CUSTOM_LOG
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • PROJECT_CODE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • PROJECT_CALENDAR
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • COPY_ACTUALS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \nExample:\n
                                                                                                                                                                                                                  { \"ACTIVITY\": true, \"RESOURCE\": true }
                                                                                                                                                                                                                  \n

                                                                                                                                                                                                                  Note: To copy either \"RESOURCE\" or \"ROLE\", both options must be set to true.

                                                                                                                                                                                                                  \n
                                                                                                                                                                                                                  \nCOPY_ACTUALS Option and Group Dependencies\n

                                                                                                                                                                                                                  The COPY_ACTUALS option enables copying of actuals data (project progress data) for supported features. When COPY_ACTUALS is set to true, certain features are grouped together for dependency management.

                                                                                                                                                                                                                  \nFeature groups:\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • Schedule Actuals Group: ACTIVITY, RELATIONSHIP, ASSIGNMENT
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Resource Actuals Group: RESOURCE, ROLE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Risk Actuals Group: RISK, MATRIX, ACTIVITY_UNCERTAINTY
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Task Actuals Group: TASK, TASK_HANDOFFS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \nDependency rules when COPY_ACTUALS is true:\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • If any member of a group is included and COPY_ACTUALS is true, all features in that group are automatically set to true by the system, regardless of whether they were specified or set to false in the input map.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Inclusion of any feature within the Risk Actuals Group results in all members of the Schedule Actuals Group also being copied, ensuring consistency and completeness of the actuals data.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \nExamples:\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • With { \"TASK\": true, \"COPY_ACTUALS\": true }, both TASK and TASK_HANDOFFS will be copied.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • With { \"RISK\": true, \"COPY_ACTUALS\": true }, the following features will be copied: RISK, MATRIX, ACTIVITY_UNCERTAINTY, ACTIVITY, RELATIONSHIP, and ASSIGNMENT.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \n

                                                                                                                                                                                                                  When COPY_ACTUALS is not enabled, only the features explicitly set to true are copied, and no automatic group expansion occurs.

                                                                                                                                                                                                                  ", "deprecated":true, "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_RESOURCE_DOCUMENT_KEY:project_resource_copyOptions_description" } }, "parentProject":{ "type":"integer", "description":"The workspace the project is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "priorityNum":{ "maximum":10000, "minimum":1, "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "primaryProgramCode":{ "maxLength":60, "type":"string", "description":"The user-defined identifier of a primary program of a project. This field is intended to be used while updating a project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStartDate":{ "type":"string", "description":"The earliest possible date the remaining work for the activity is scheduled to begin. This date is calculated by the project scheduler but can be updated manually by the user. Before the activity is started, the Remaining Start is the same as the Project Planned Start. Once the activity has started, the Remaining Start is equal to the Data Date. When the activity is complete, the Remaining Start is blank.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinishDate":{ "type":"string", "description":"The earliest possible date the remaining work for the activity is scheduled to finish. This date is calculated by the project scheduler but can be updated manually by the user. Before the activity is started, the Remaining Finish is the same as the Planned Finish. When the activity is complete, the Remaining Finish is blank.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "recordCount":{ "type":"integer", "description":"The number of comments on a project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "securityGuid":{ "maxLength":32, "type":"string", "description":"Globally unique identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "scheduledFinishDate":{ "type":"string", "description":"The calculated latest early finish date, which is based on the schedule most recently generated for the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The Actual Start indicates the date work on the project began.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The Actual Finish displays the date on which a project is considered complete.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastFinishDate":{ "type":"string", "description":"The planned finish date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastStartDate":{ "type":"string", "description":"The planned start date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendStartDate":{ "type":"string", "description":"The start date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendFinishDate":{ "type":"string", "description":"The finish date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsStartDate":{ "type":"string", "description":"The date benefits on the project began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsFinishDate":{ "type":"string", "description":"The date benefits on the project finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationScore":{ "type":"number", "description":"The quantitative score of a project based on the qualitative ranking of projects against different evaluation categories. This value is used by portfolio managers to prioritize projects.", "format":"double", "exampleSetFlag":false }, "spendEffectiveDate":{ "type":"string", "description":"The month in which an actuals value was last added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastToSpend":{ "type":"boolean", "description":"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.", "exampleSetFlag":false, "types":[ "boolean" ] }, "forecastLinkType":{ "type":"string", "description":"The type of forecast data linked to a project. Forecast data represents an estimation of a project's remaining costs.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "INTEGRATION" ] }, "plannedBudgetLinkType":{ "type":"string", "description":"Type of data to which a project's planned budget is linked.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "BUDGET", "INTEGRATION" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The estimated percentage of work that has been completed on the project. This value is entered by the user.", "format":"double", "exampleSetFlag":false }, "riskMatrixId":{ "type":"integer", "description":"The risk matrix assigned to the project for calculating project risk scores.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reportCycleId":{ "type":"integer", "description":"The reporting cycle assigned to the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCashFlows":{ "type":"array", "description":"The cash flow of a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCashFlow", "exampleSetFlag":false }, "types":[ "array" ] }, "primaryProgramId":{ "type":"integer", "description":"The system-generated identifier of a primary program of a project. This field is intended to be used while updating a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskAnalysisJobStatus":{ "type":"string", "description":"The status of the most recent risk analysis service.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_RAN_YET", "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ] }, "riskAnalysisStartDate":{ "type":"string", "description":"The start time of the most recent risk analysis service.", "format":"date-time", "exampleSetFlag":false }, "riskAnalysisFinishDate":{ "type":"string", "description":"The finish time of the most recent risk analysis service.", "format":"date-time", "exampleSetFlag":false }, "riskAnalysisDuration":{ "type":"number", "description":"The duration of the most recent risk analysis service.", "format":"double", "exampleSetFlag":false }, "actualLinkType":{ "type":"string", "description":"Type of actuals data linked to a project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "ACTUAL", "INTEGRATION" ] }, "projectSettings":{ "type":"array", "description":"The project settings associated with the project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "planEndDate":{ "type":"string", "description":"The finish date for the time phased Planned Budget of the project.
                                                                                                                                                                                                                  Planned Budget cost spread will adjust when this date is changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planStartDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "websiteUrl":{ "maxLength":200, "minLength":0, "type":"string", "description":"The link to a website related to the project.", "exampleSetFlag":false, "types":[ "string" ] }, "dataDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planDuration":{ "type":"number", "description":"The duration between Project Planned Start and Project Planned Finish.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "startDateVariance":{ "type":"number", "description":"The duration between the project's start date and the baseline's start date.
                                                                                                                                                                                                                  When the field value is generated through a P6 EPPM connection, then it represents the duration between the start date in the current project and the baseline start date.
                                                                                                                                                                                                                  This value can only be imported.", "format":"double", "exampleSetFlag":false }, "finishDateVariance":{ "type":"number", "description":"The duration between the project's finish date and the baseline's finish date.
                                                                                                                                                                                                                  When the field value is generated through a P6 EPPM connection, then it represents the duration between the finish date in the current project and the baseline finish date.
                                                                                                                                                                                                                  This value can only be imported.", "format":"double", "exampleSetFlag":false }, "strgyPriorityNum":{ "maximum":10000, "minimum":1, "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "mustFinishByDate":{ "type":"string", "description":"The latest date on which the scheduled activities must be complete for a project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkPlannedBudgetTo":{ "type":"integer", "description":"Specifies data to which a project planned budget is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linkForecastTo":{ "type":"integer", "description":"Specifies data to which a project forecast is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linkActualTo":{ "type":"integer", "description":"Specifies data to which project actuals data is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isTemplateFlag":{ "type":"boolean", "description":"Indicates the project is a template for creating other projects.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exchangeRate":{ "type":"number", "description":"The custom exchange rate for the currency assigned to the project.", "exampleSetFlag":false, "types":[ "number" ] }, "projectIntegrationType":{ "type":"string", "description":"Specifies if the project is integrated with another application.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "P6", "UNIFIER" ] }, "riskLevel":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ] }, "riskScore":{ "type":"integer", "description":"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.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectTimeZone":{ "type":"string", "description":"The time zone of the project's location.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "INTERNATIONAL_DATE_LINE_WEST", "MIDWAY_ISLAND_SAMOA", "HAWAII", "ALASKA", "PACIFIC_TIME", "ARIZONA", "CHIHUAHUA_LA_PAZ_MAZATLAN", "MOUNTAIN_TIME", "CENTRAL_AMERICA", "CENTRAL_TIME", "GUADALAJARA_MEXICO_CITY_MONTERREY", "SASKATCHEWAN", "BOGOTA_LIMA_QUITO", "EASTERN_TIME", "INDIANA", "ATLANTIC_TIME", "CARACAS_LA_PAZ_PUERTO_RICO", "SANTIAGO", "NEWFOUNDLAND", "BRASILIA", "BUENOS_AIRES_GEORGETOWN", "MID_ATLANTIC", "AZORES", "CAPE_VERDE_IS", "CASABLANCA_MONROVIA", "GREENWICH_MEAN_TIME", "AMSTERDAM_BERLIN_BERN", "BELGRADE_BRATISLAVA_BUDAPEST", "BRUSSELS_COPENHAGEN_MADRID", "SARAJEVO_SKOPJE_WARSAW", "WEST_CENTRAL_AFRICA", "ATHENS_BEIRUT_ISTANBUL", "BUCHAREST", "CAIRO", "HARARE_PRETORIA", "HELSINKI_KVIV_RIGA", "JERUSALEM", "BAGHDAD", "KUWAIT_RIYADH", "NAIROBI", "MOSCOW_ST_PETERSBURG", "TEHRAN", "ABU_DHADI_MUSCAT", "BAKU_TBILISI_YEREVAN", "KABUL", "ISLAMABAD_KARACHI_TASHKENT", "CHENNAI_KOLKATA_MUMBAI", "ASTANA_DHAKA", "RANGOON", "BANGKOK_HANOI_JAKARTA", "BEJING_CHONGQING_HONG_KONG", "KUALA_LUMPUR_SINGAPORE", "PERTH", "TAIPEI", "OSAKA_SAPPORO_TOKYO", "SEOUL", "ADELAIDE", "DARWIN", "BRISBANE", "CANBERRA_MELBOURNE_SYDNEY", "GUAM_PORT_MORESBY", "HOBART", "MAGADAN_SOLOMON_IS_NEW_CALEDONIA", "AUCKLAND_WELLINGTON" ] }, "projectCurrency":{ "type":"integer", "description":"The unique identifier of the currency to be used in the project. Currencies configured in the immediate parent workspace, with at least one exchange rate configured, are available to be used in the project. If no value is specified, the parent workspace currency will be selected.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "openEndsActivityCount":{ "type":"integer", "description":"The number of activities in the project without predecessors or successors.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "largeFloatActivityCount":{ "type":"integer", "description":"The number of activities in the project with an Activity Total Float that meets or exceeds the given criteria value. The default value is 320h.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "noResourceActivityCount":{ "type":"integer", "description":"The number of activities in the project without role or resource assignments.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "lateActivityCount":{ "type":"integer", "description":"The number of activities in the project with an Activity Baseline Finish Variance less than 0 or without a set activity baseline.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "totalActivityCount":{ "type":"integer", "description":"The total number of activities in the project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "openEndsActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without predecessors or successors.", "format":"double", "exampleSetFlag":false }, "lateActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with an Activity Baseline Finish Variance less than 0 or without a set activity baseline.", "format":"double", "exampleSetFlag":false }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of appearance of projects in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "managerId":{ "type":"integer", "description":"The user id of a manager or person responsible for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationMatrixId":{ "type":"integer", "description":"The evaluation matrix of a calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of a project in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The date on which work on the project starts.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The date on which all project work is complete.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The duration between the Project Start and Project Finish.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualDuration":{ "type":"number", "description":"The Actual Duration represents the total working time between the project Actual Start and Actual Finish for a project.
                                                                                                                                                                                                                  This value can be imported. The Actual Duration field is not editable.", "format":"double", "exampleSetFlag":false }, "proposedStartDate":{ "type":"string", "description":"The start date for the Proposed Budget of the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedFinishDate":{ "type":"string", "description":"The finish date for the Proposed Budget of the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "locationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                  This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                  This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "minLength":0, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manager":{ "maxLength":255, "type":"string", "description":"The user name of a manager or person responsible for the project.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETE" ] }, "image":{ "description":"The image associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectImage" } ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityNotebookTopicProject":{ "title":"ApiEntityNotebookTopicProject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectNotesId":{ "type":"integer", "description":"The unique identifier for the notebook topic and its project association.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "maxLength":0, "type":"string", "description":"The unique identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "notes":{ "type":"string", "description":"The notes for the notebook topic in HTML format.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityAssignedPermissionsProject":{ "title":"ApiEntityAssignedPermissionsProject", "type":"object", "properties":{ "file":{ "description":"File permission sets.
                                                                                                                                                                                                                  Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "customLog":{ "description":"Custom log permission sets.
                                                                                                                                                                                                                  Applicable for workspace, project, program, customLogTypeObject retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "project":{ "description":"Project permission sets.
                                                                                                                                                                                                                  Applicable for workspace, project retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "report":{ "description":"Report permission sets.
                                                                                                                                                                                                                  Applicable for workspace, project, program, portfolio, report retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] } }, "exampleSetFlag":false }, "ApiEntityAssignedUsers":{ "title":"ApiEntityAssignedUsers", "type":"object", "properties":{ "displayName":{ "type":"string", "description":"The name displayed of the user when logged into the system. ", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "type":"string", "description":"The identification used by a user to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBaseProfile":{ "title":"ApiEntityBaseProfile", "type":"object", "properties":{ "profileName":{ "maxLength":255, "type":"string", "description":"Profile Name.", "exampleSetFlag":false, "types":[ "string" ] }, "profileId":{ "maxLength":255, "type":"string", "description":"Profile ID.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityUserGroupsPermissionAssignmentsProject":{ "title":"ApiEntityUserGroupsPermissionAssignmentsProject", "type":"object", "properties":{ "userGroupName":{ "type":"string", "description":"The name displayed of the user group.", "exampleSetFlag":false, "types":[ "string" ] }, "assignedPermissions":{ "description":"List of assigned user permission profiles in the user group.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityAssignedPermissionsProject" } ] }, "assignedUsers":{ "type":"array", "description":"List of assigned users in the user group.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignedUsers", "exampleSetFlag":false }, "types":[ "array" ] }, "userGroupId":{ "type":"string", "description":"The unique identifier of the user group.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityUserGroup":{ "title":"ApiEntityUserGroup", "type":"object", "properties":{ "displayName":{ "maxLength":255, "type":"string", "description":"Name of a user group.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeId":{ "type":"integer", "description":"The unique identifier of a project/workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "assignedUsers":{ "type":"array", "description":"List of assigned users in the user group.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignedUsers", "exampleSetFlag":false }, "types":[ "array" ] }, "ownedWorkspaceName":{ "type":"string", "description":"The name of the owning workspace of the user group.", "exampleSetFlag":false, "types":[ "string" ] }, "inherited":{ "type":"boolean", "description":"Indicates if the user group is inherited.", "exampleSetFlag":false, "types":[ "boolean" ] }, "userGroupEnabled":{ "type":"boolean", "description":"Indicates the state of the user group.", "exampleSetFlag":false, "types":[ "boolean" ] }, "ownedWorkspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userGroupId":{ "type":"integer", "description":"The unique identifier of a user group.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "type":"string", "description":"Indicates whether the user group is present in the workspace/project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT", "WORKSPACE" ] } }, "exampleSetFlag":false }, "ApiEntityUserGroups":{ "title":"ApiEntityUserGroups", "type":"object", "properties":{ "userGroups":{ "type":"array", "description":"User Groups Data.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUserGroup", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityUserPermissionAssignmentsProject":{ "title":"ApiEntityUserPermissionAssignmentsProject", "type":"object", "properties":{ "displayName":{ "type":"string", "description":"The name displayed of the user when logged into the system. ", "exampleSetFlag":false, "types":[ "string" ] }, "assignedPermissions":{ "description":"List of assigned user permission profiles.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityAssignedPermissionsProject" } ] }, "userName":{ "type":"string", "description":"The identification used by a user to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityBaselineProject":{ "title":"ApiEntityBaselineProject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "currentApprovedStartDate":{ "type":"string", "description":"The start date for the Current Approved Budget set by the budget planner.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "currentApprovedFinishDate":{ "type":"string", "description":"The finish date for the Current Approved Budget set by the budget planner.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "reportCycleNamingBoundary":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ] }, "noPredecessorActivityCount":{ "type":"integer", "description":"The number of activities in the project without predecessors.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "noSuccessorActivityCount":{ "type":"integer", "description":"The number of activities in the project without successors.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "danglingStartActivityCount":{ "type":"integer", "description":"The number of activities in the project that only have Start-to-Finish or Finish-to-Finish predecessor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Start-to-Start predecessor; No Start-to-Start successor; No Start-to-Finish successor; No Finish-to-Start predecessor. If the activity type is Milestone, the activity is not counted.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "danglingFinishActivityCount":{ "type":"integer", "description":"The number of activities in the project that only have Start-to-Finish or Start-to-Start successor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Finish-to-Finish predecessor; No Finish-to-Finish successor; No Start-to-Finish predecessor; No Finish-to-Start successor. If the activity type is Milestone, the activity is not counted.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "predecessorNegativeLagActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a lag less than 0.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "predecessorLagActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a lag greater than 0.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "fsPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Finish-to-Start (FS).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ssPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Start-to-Start (SS).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ffPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Finish-to-Finish (FF).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "sfPredecessorActivityCount":{ "type":"integer", "description":"The number of predecessor relationships in the project with a type of Start-to-Finish (SF).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "hardConstraintActivityCount":{ "type":"integer", "description":"The number of activities in the project with a primary constraint of Mandatory Start or Mandatory Finish.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "softConstraintActivityCount":{ "type":"integer", "description":"The number of activities in the project with a primary constraint of As Late As Possible, Finish On, Finish On or After, Finish On or Before, Start On, Start On or After, or Start On or Before.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "negativeFloatActivityCount":{ "type":"integer", "description":"The number of activities in the project with a total float less than 0.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "largeDurationActivityCount":{ "type":"integer", "description":"The number of activities in the project with an Activity Remaining Duration that meets or exceeds the given criteria value. The default value is 320h.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "invalidProgressDateActivityCount":{ "type":"integer", "description":"The number of activities in the project with invalid progress. An activity is included in the count if any of the following are true: Activity Planned Start less than Data Date unless Activity has Actual Start; Activity Planned Finish less than or equal to Data Date and Activity is Not Started; Activity Actual Start greater than or equal to Data Date; Activity Actual Finish greater than Data Date.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "noPredecessorActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without predecessors.", "format":"double", "exampleSetFlag":false }, "noSuccessorActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without successors.", "format":"double", "exampleSetFlag":false }, "danglingStartActivityPercent":{ "type":"number", "description":"The percentage of activities in the project that only have Start-to-Finish or Finish-to-Finish predecessor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Start-to-Start predecessor; No Start-to-Start successor; No Start-to-Finish successor; No Finish-to-Start predecessor. If the activity type is Milestone, the activity is not counted.", "format":"double", "exampleSetFlag":false }, "danglingFinishActivityPercent":{ "type":"number", "description":"The percentage of activities in the project that only have Start-to-Finish or Start-to-Start successor relationships. If the activity type is Level of Effort, the activity is counted if all of the following are true: No Finish-to-Finish predecessor; No Finish-to-Finish successor; No Start-to-Finish predecessor; No Finish-to-Start successor. If the activity type is Milestone, the activity is not counted.", "format":"double", "exampleSetFlag":false }, "predecessorNegativeLagActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a lag less than 0.", "format":"double", "exampleSetFlag":false }, "predecessorLagActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a lag greater than 0.", "format":"double", "exampleSetFlag":false }, "fsPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Finish-to-Start (FS).", "format":"double", "exampleSetFlag":false }, "ssPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Start-to-Start (SS).", "format":"double", "exampleSetFlag":false }, "ffPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Finish-to-Finish (FF).", "format":"double", "exampleSetFlag":false }, "sfPredecessorActivityPercent":{ "type":"number", "description":"The percentage of predecessor relationships in the project with a type of Start-to-Finish (SF).", "format":"double", "exampleSetFlag":false }, "hardConstraintActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with a primary constraint of Mandatory Start or Mandatory Finish.", "format":"double", "exampleSetFlag":false }, "softConstraintActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with a primary constraint of As Late As Possible, Finish On, Finish On or After, Finish On or Before, Start On, Start On or After, or Start On or Before.", "format":"double", "exampleSetFlag":false }, "largeFloatActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with an Activity Total Float that meets or exceeds the given criteria value. The default value is 320h.", "format":"double", "exampleSetFlag":false }, "negativeFloatActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with a total float less than 0.", "format":"double", "exampleSetFlag":false }, "largeDurationActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with an Activity Remaining Duration that meets or exceeds the given criteria value. The default value is 320h.", "format":"double", "exampleSetFlag":false }, "noResourceActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without role or resource assignments.", "format":"double", "exampleSetFlag":false }, "invalidProgressDateActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with invalid progress. An activity is included in the count if any of the following are true: Activity Planned Start less than Data Date; Activity Planned Finish less than or equal to Data Date; Activity Actual Start greater than or equal to Data Date; Activity Actual Finish greater than Data Date.", "format":"double", "exampleSetFlag":false }, "projectScheduleHealthPercent":{ "type":"number", "description":"The weighted aggregation of active check values that represents the overall quality of your project. A higher schedule health score indicates a higher quality schedule. Calculated as 100% - (Sum of [Check Adjusted Percentage * Check Weighting] / Sum of all active check weighting values)", "format":"double", "exampleSetFlag":false }, "percentCompleteWeightedBy":{ "type":"string", "description":"The weight for scope items is calculated using quantity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COST", "QUANTITY", "HOURS", "MANUAL" ] }, "breakdownCapitalForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "lastProjectEvaluationDate":{ "type":"string", "description":"The date on which the project was last evaluated. ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "copyFromProjectId":{ "type":"integer", "description":"Deprecated. As of 26.1.
                                                                                                                                                                                                                  The system-generated unique identifier of the project or project template from which the new project needs to be copied from.", "format":"int64", "deprecated":true, "exampleSetFlag":false, "types":[ "integer" ] }, "copyCustomLogTypes":{ "type":"array", "description":"Name of custom log types from the project or project template to be copied to create a new project.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "codeValuesProject":{ "type":"array", "description":"The list of code values for a project. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProject", "exampleSetFlag":false }, "types":[ "array" ] }, "projectFinancial":{ "description":"The financial fields associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectFinancial" } ] }, "projectAutoNumber":{ "type":"array", "description":"The autonumber settings of a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectAutoNumber", "exampleSetFlag":false }, "types":[ "array" ] }, "projectTerm":{ "type":"string", "description":"Project termination date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "copyOptions":{ "type":"object", "description":"Deprecated. As of 26.1.

                                                                                                                                                                                                                  The copy options map controls which features are copied when creating a new project from an existing project or project template. Each entry uses a feature name as the key and a boolean value (true or false) to determine whether the corresponding feature is included in the new project. Features not specified or explicitly set to false are excluded from the copy operation.

                                                                                                                                                                                                                  \nMap Keys (Allowed Values):\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • ACTIVITY
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • RELATIONSHIP
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • RESOURCE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • ROLE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • ASSIGNMENT
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • TASK
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • TASK_HANDOFFS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • RISK
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • MATRIX
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • ACTIVITY_UNCERTAINTY
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • WBS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • AUTO_NUMBERING
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • MANAGER
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • PROJECT_SETTINGS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • CALENDAR
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • UOM
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • MONTECARLO_SETTING
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • CUSTOM_LOG
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • PROJECT_CODE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • PROJECT_CALENDAR
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • COPY_ACTUALS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \nExample:\n
                                                                                                                                                                                                                  { \"ACTIVITY\": true, \"RESOURCE\": true }
                                                                                                                                                                                                                  \n

                                                                                                                                                                                                                  Note: To copy either \"RESOURCE\" or \"ROLE\", both options must be set to true.

                                                                                                                                                                                                                  \n
                                                                                                                                                                                                                  \nCOPY_ACTUALS Option and Group Dependencies\n

                                                                                                                                                                                                                  The COPY_ACTUALS option enables copying of actuals data (project progress data) for supported features. When COPY_ACTUALS is set to true, certain features are grouped together for dependency management.

                                                                                                                                                                                                                  \nFeature groups:\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • Schedule Actuals Group: ACTIVITY, RELATIONSHIP, ASSIGNMENT
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Resource Actuals Group: RESOURCE, ROLE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Risk Actuals Group: RISK, MATRIX, ACTIVITY_UNCERTAINTY
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Task Actuals Group: TASK, TASK_HANDOFFS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \nDependency rules when COPY_ACTUALS is true:\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • If any member of a group is included and COPY_ACTUALS is true, all features in that group are automatically set to true by the system, regardless of whether they were specified or set to false in the input map.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Inclusion of any feature within the Risk Actuals Group results in all members of the Schedule Actuals Group also being copied, ensuring consistency and completeness of the actuals data.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \nExamples:\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • With { \"TASK\": true, \"COPY_ACTUALS\": true }, both TASK and TASK_HANDOFFS will be copied.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • With { \"RISK\": true, \"COPY_ACTUALS\": true }, the following features will be copied: RISK, MATRIX, ACTIVITY_UNCERTAINTY, ACTIVITY, RELATIONSHIP, and ASSIGNMENT.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \n

                                                                                                                                                                                                                  When COPY_ACTUALS is not enabled, only the features explicitly set to true are copied, and no automatic group expansion occurs.

                                                                                                                                                                                                                  ", "deprecated":true, "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_RESOURCE_DOCUMENT_KEY:project_resource_copyOptions_description" } }, "parentProject":{ "type":"integer", "description":"The workspace the project is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "priorityNum":{ "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "primaryProgramCode":{ "maxLength":60, "type":"string", "description":"The user-defined identifier of a primary program of a project. This field is intended to be used while updating a project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":1, "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ] }, "remainingStartDate":{ "type":"string", "description":"The earliest possible date the remaining work for the activity is scheduled to begin. This date is calculated by the project scheduler but can be updated manually by the user. Before the activity is started, the Remaining Start is the same as the Project Planned Start. Once the activity has started, the Remaining Start is equal to the Data Date. When the activity is complete, the Remaining Start is blank.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingFinishDate":{ "type":"string", "description":"The earliest possible date the remaining work for the activity is scheduled to finish. This date is calculated by the project scheduler but can be updated manually by the user. Before the activity is started, the Remaining Finish is the same as the Planned Finish. When the activity is complete, the Remaining Finish is blank.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "recordCount":{ "type":"integer", "description":"The number of comments on a project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "securityGuid":{ "maxLength":32, "type":"string", "description":"Globally unique identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "scheduledFinishDate":{ "type":"string", "description":"The calculated latest early finish date, which is based on the schedule most recently generated for the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The Actual Start indicates the date work on the project began.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The Actual Finish displays the date on which a project is considered complete.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastFinishDate":{ "type":"string", "description":"The planned finish date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastStartDate":{ "type":"string", "description":"The planned start date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendStartDate":{ "type":"string", "description":"The start date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendFinishDate":{ "type":"string", "description":"The finish date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsStartDate":{ "type":"string", "description":"The date benefits on the project began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsFinishDate":{ "type":"string", "description":"The date benefits on the project finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationScore":{ "type":"number", "description":"The quantitative score of a project based on the qualitative ranking of projects against different evaluation categories. This value is used by portfolio managers to prioritize projects.", "format":"double", "exampleSetFlag":false }, "spendEffectiveDate":{ "type":"string", "description":"The month in which an actuals value was last added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastToSpend":{ "type":"boolean", "description":"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.", "exampleSetFlag":false, "types":[ "boolean" ] }, "forecastLinkType":{ "type":"string", "description":"The type of forecast data linked to a project. Forecast data represents an estimation of a project's remaining costs.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "INTEGRATION" ] }, "plannedBudgetLinkType":{ "type":"string", "description":"Type of data to which a project's planned budget is linked.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "BUDGET", "INTEGRATION" ] }, "percentComplete":{ "type":"number", "description":"The estimated percentage of work that has been completed on the project. This value is entered by the user.", "format":"double", "exampleSetFlag":false }, "riskMatrixId":{ "type":"integer", "description":"The risk matrix assigned to the project for calculating project risk scores.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reportCycleId":{ "type":"integer", "description":"The reporting cycle assigned to the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "primaryProgramId":{ "type":"integer", "description":"The system-generated identifier of a primary program of a project. This field is intended to be used while updating a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskAnalysisJobStatus":{ "type":"string", "description":"The status of the most recent risk analysis service.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_RAN_YET", "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ] }, "riskAnalysisStartDate":{ "type":"string", "description":"The start time of the most recent risk analysis service.", "format":"date-time", "exampleSetFlag":false }, "riskAnalysisFinishDate":{ "type":"string", "description":"The finish time of the most recent risk analysis service.", "format":"date-time", "exampleSetFlag":false }, "riskAnalysisDuration":{ "type":"number", "description":"The duration of the most recent risk analysis service.", "format":"double", "exampleSetFlag":false }, "actualLinkType":{ "type":"string", "description":"Type of actuals data linked to a project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "ACTUAL", "INTEGRATION" ] }, "projectSettings":{ "type":"array", "description":"The project settings associated with the project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "planEndDate":{ "type":"string", "description":"The finish date for the time phased Planned Budget of the project.
                                                                                                                                                                                                                  Planned Budget cost spread will adjust when this date is changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planStartDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "websiteUrl":{ "maxLength":200, "minLength":1, "type":"string", "description":"The link to a website related to the project.", "exampleSetFlag":false, "types":[ "string" ] }, "dataDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planDuration":{ "type":"number", "description":"The duration between Project Planned Start and Project Planned Finish.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "startDateVariance":{ "type":"number", "description":"The duration between the project's start date and the baseline's start date.
                                                                                                                                                                                                                  When the field value is generated through a P6 EPPM connection, then it represents the duration between the start date in the current project and the baseline start date.
                                                                                                                                                                                                                  This value can only be imported.", "format":"double", "exampleSetFlag":false }, "finishDateVariance":{ "type":"number", "description":"The duration between the project's finish date and the baseline's finish date.
                                                                                                                                                                                                                  When the field value is generated through a P6 EPPM connection, then it represents the duration between the finish date in the current project and the baseline finish date.
                                                                                                                                                                                                                  This value can only be imported.", "format":"double", "exampleSetFlag":false }, "strgyPriorityNum":{ "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "mustFinishByDate":{ "type":"string", "description":"The latest date on which the scheduled activities must be complete for a project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkPlannedBudgetTo":{ "type":"integer", "description":"Specifies data to which a project planned budget is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linkForecastTo":{ "type":"integer", "description":"Specifies data to which a project forecast is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linkActualTo":{ "type":"integer", "description":"Specifies data to which project actuals data is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isTemplateFlag":{ "type":"boolean", "description":"Indicates the project is a template for creating other projects.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exchangeRate":{ "type":"number", "description":"The custom exchange rate for the currency assigned to the project.", "exampleSetFlag":false, "types":[ "number" ] }, "projectIntegrationType":{ "type":"string", "description":"Specifies if the project is integrated with another application.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "P6", "UNIFIER" ] }, "riskLevel":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ] }, "riskScore":{ "type":"integer", "description":"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.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectTimeZone":{ "type":"string", "description":"The time zone of the project's location.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "INTERNATIONAL_DATE_LINE_WEST", "MIDWAY_ISLAND_SAMOA", "HAWAII", "ALASKA", "PACIFIC_TIME", "ARIZONA", "CHIHUAHUA_LA_PAZ_MAZATLAN", "MOUNTAIN_TIME", "CENTRAL_AMERICA", "CENTRAL_TIME", "GUADALAJARA_MEXICO_CITY_MONTERREY", "SASKATCHEWAN", "BOGOTA_LIMA_QUITO", "EASTERN_TIME", "INDIANA", "ATLANTIC_TIME", "CARACAS_LA_PAZ_PUERTO_RICO", "SANTIAGO", "NEWFOUNDLAND", "BRASILIA", "BUENOS_AIRES_GEORGETOWN", "MID_ATLANTIC", "AZORES", "CAPE_VERDE_IS", "CASABLANCA_MONROVIA", "GREENWICH_MEAN_TIME", "AMSTERDAM_BERLIN_BERN", "BELGRADE_BRATISLAVA_BUDAPEST", "BRUSSELS_COPENHAGEN_MADRID", "SARAJEVO_SKOPJE_WARSAW", "WEST_CENTRAL_AFRICA", "ATHENS_BEIRUT_ISTANBUL", "BUCHAREST", "CAIRO", "HARARE_PRETORIA", "HELSINKI_KVIV_RIGA", "JERUSALEM", "BAGHDAD", "KUWAIT_RIYADH", "NAIROBI", "MOSCOW_ST_PETERSBURG", "TEHRAN", "ABU_DHADI_MUSCAT", "BAKU_TBILISI_YEREVAN", "KABUL", "ISLAMABAD_KARACHI_TASHKENT", "CHENNAI_KOLKATA_MUMBAI", "ASTANA_DHAKA", "RANGOON", "BANGKOK_HANOI_JAKARTA", "BEJING_CHONGQING_HONG_KONG", "KUALA_LUMPUR_SINGAPORE", "PERTH", "TAIPEI", "OSAKA_SAPPORO_TOKYO", "SEOUL", "ADELAIDE", "DARWIN", "BRISBANE", "CANBERRA_MELBOURNE_SYDNEY", "GUAM_PORT_MORESBY", "HOBART", "MAGADAN_SOLOMON_IS_NEW_CALEDONIA", "AUCKLAND_WELLINGTON" ] }, "projectCurrency":{ "type":"integer", "description":"The unique identifier of the currency to be used in the project. Currencies configured in the immediate parent workspace, with at least one exchange rate configured, are available to be used in the project. If no value is specified, the parent workspace currency will be selected.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "openEndsActivityCount":{ "type":"integer", "description":"The number of activities in the project without predecessors or successors.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "largeFloatActivityCount":{ "type":"integer", "description":"The number of activities in the project with an Activity Total Float that meets or exceeds the given criteria value. The default value is 320h.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "noResourceActivityCount":{ "type":"integer", "description":"The number of activities in the project without role or resource assignments.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "lateActivityCount":{ "type":"integer", "description":"The number of activities in the project with an Activity Baseline Finish Variance less than 0 or without a set activity baseline.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "totalActivityCount":{ "type":"integer", "description":"The total number of activities in the project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "openEndsActivityPercent":{ "type":"number", "description":"The percentage of activities in the project without predecessors or successors.", "format":"double", "exampleSetFlag":false }, "lateActivityPercent":{ "type":"number", "description":"The percentage of activities in the project with an Activity Baseline Finish Variance less than 0 or without a set activity baseline.", "format":"double", "exampleSetFlag":false }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of appearance of projects in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "managerId":{ "type":"integer", "description":"The user id of a manager or person responsible for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationMatrixId":{ "type":"integer", "description":"The evaluation matrix of a calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of a project in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The date on which work on the project starts.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The date on which all project work is complete.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The duration between the Project Start and Project Finish.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"double", "exampleSetFlag":false }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualDuration":{ "type":"number", "description":"The Actual Duration represents the total working time between the project Actual Start and Actual Finish for a project.
                                                                                                                                                                                                                  This value can be imported. The Actual Duration field is not editable.", "format":"double", "exampleSetFlag":false }, "proposedStartDate":{ "type":"string", "description":"The start date for the Proposed Budget of the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedFinishDate":{ "type":"string", "description":"The finish date for the Proposed Budget of the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "locationName":{ "maxLength":255, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                  This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                  This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manager":{ "maxLength":255, "type":"string", "description":"The user name of a manager or person responsible for the project.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveProjectUserPermissionsResponse":{ "title":"ApiEntityRemoveProjectUserPermissionsResponse", "type":"object", "properties":{ "message":{ "type":"string", "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveProjectUserPermissions":{ "title":"ApiEntityRemoveProjectUserPermissions", "type":"object", "properties":{ "userNames":{ "type":"array", "description":"List of user names for removing users.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveProjectUserGroupPermissionsResponse":{ "title":"ApiEntityRemoveProjectUserGroupPermissionsResponse", "type":"object", "properties":{ "message":{ "type":"string", "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "userGroupId":{ "type":"string", "description":"System-defined identifier of the user group.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveProjectUserGroupPermissions":{ "title":"ApiEntityRemoveProjectUserGroupPermissions", "type":"object", "properties":{ "userGroupIds":{ "type":"array", "description":"List of user group IDs for removing user groups.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityExternallySourcedProjectInput":{ "title":"ApiEntityExternallySourcedProjectInput", "required":[ "dataDate", "planStartDate", "projectCode", "projectName", "workspaceId" ], "type":"object", "properties":{ "roleDemandCommitDuration":{ "type":"number", "description":"The total duration of committed demand resources.", "format":"double", "exampleSetFlag":false }, "roleDemandCommitStartDate":{ "type":"string", "description":"The start date for committed demand data.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectCurrencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The user-specified identifier of the project's assigned currency.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMatrixCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of the project's assigned risk matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "roleCommittedFte":{ "type":"number", "description":"The total committed FTE. Calculated as total commitment units divided by total commitment duration.", "exampleSetFlag":false, "types":[ "number" ] }, "roleDemandFte":{ "type":"number", "description":"The total demand FTE. Calculated as total demand units divided by total demand duration.", "exampleSetFlag":false, "types":[ "number" ] }, "roleDemandCommittedUnit":{ "type":"number", "description":"Indicates whether or not resources were committed for this demand.", "format":"double", "exampleSetFlag":false }, "roleDemandCommitEndDate":{ "type":"string", "description":"The finish date for committed demand data.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "roleDemandUnits":{ "type":"number", "description":"The demand units entered for a single role.", "format":"double", "exampleSetFlag":false }, "roleDemandDuration":{ "type":"number", "description":"The total expected duration of the weekly demand data.", "format":"double", "exampleSetFlag":false }, "roleDemandEndDate":{ "type":"string", "description":"The finish date for the weekly demand data. Calculated as Start plus Total Demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "roleDemandStartDate":{ "type":"string", "description":"The start date for weekly demand data.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's assigned calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "street":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                  This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "street2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                  This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "breakdownCapitalForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForPlannedBudget":{ "type":"boolean", "description":"Enables you breakdown planned budget total into planned budget expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForActual":{ "type":"boolean", "description":"Enables you breakdown spends total into spends expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownCapitalForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast capital.", "exampleSetFlag":false, "types":[ "boolean" ] }, "breakdownExpenseForForecast":{ "type":"boolean", "description":"Enables you breakdown forecast total into forecast expense.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectIntegrationSourceDetails":{ "description":"The integration source details associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectIntegrationSourceInput" } ] }, "copyFromProjectId":{ "type":"integer", "description":"The system-generated unique identifier of the project or project template from which the new project needs to be copied from.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "copyCustomLogTypes":{ "type":"array", "description":"Name of custom log types from the project or project template to be copied to create a new project.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "codeValuesProject":{ "type":"array", "description":"The list of code values for a project. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueProjectInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectFinancial":{ "description":"The financial fields associated with a project.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectFinancialInput" } ] }, "copyOptions":{ "type":"object", "description":"

                                                                                                                                                                                                                  The copy options map controls which features are copied when creating a new project from an existing project or project template. Each entry uses a feature name as the key and a boolean value (true or false) to determine whether the corresponding feature is included in the new project. Features not specified or explicitly set to false are excluded from the copy operation.

                                                                                                                                                                                                                  \nMap Keys (Allowed Values):\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • ACTIVITY
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • RELATIONSHIP
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • RESOURCE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • ROLE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • ASSIGNMENT
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • TASK
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • TASK_HANDOFFS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • RISK
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • MATRIX
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • ACTIVITY_UNCERTAINTY
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • WBS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • AUTO_NUMBERING
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • MANAGER
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • PROJECT_SETTINGS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • CALENDAR
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • UOM
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • MONTECARLO_SETTING
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • CUSTOM_LOG
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • PROJECT_CODE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • PROJECT_CALENDAR
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • COPY_ACTUALS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \nExample:\n
                                                                                                                                                                                                                  { \"ACTIVITY\": true, \"RESOURCE\": true }
                                                                                                                                                                                                                  \n

                                                                                                                                                                                                                  Note: To copy either \"RESOURCE\" or \"ROLE\", both options must be set to true.

                                                                                                                                                                                                                  \n
                                                                                                                                                                                                                  \nCOPY_ACTUALS Option and Group Dependencies\n

                                                                                                                                                                                                                  The COPY_ACTUALS option enables copying of actuals data (project progress data) for supported features. When COPY_ACTUALS is set to true, certain features are grouped together for dependency management.

                                                                                                                                                                                                                  \nFeature groups:\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • Schedule Actuals Group: ACTIVITY, RELATIONSHIP, ASSIGNMENT
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Resource Actuals Group: RESOURCE, ROLE
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Risk Actuals Group: RISK, MATRIX, ACTIVITY_UNCERTAINTY
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Task Actuals Group: TASK, TASK_HANDOFFS
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \nDependency rules when COPY_ACTUALS is true:\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • If any member of a group is included and COPY_ACTUALS is true, all features in that group are automatically set to true by the system, regardless of whether they were specified or set to false in the input map.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • Inclusion of any feature within the Risk Actuals Group results in all members of the Schedule Actuals Group also being copied, ensuring consistency and completeness of the actuals data.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \nExamples:\n
                                                                                                                                                                                                                    \n
                                                                                                                                                                                                                  • With { \"TASK\": true, \"COPY_ACTUALS\": true }, both TASK and TASK_HANDOFFS will be copied.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  • With { \"RISK\": true, \"COPY_ACTUALS\": true }, the following features will be copied: RISK, MATRIX, ACTIVITY_UNCERTAINTY, ACTIVITY, RELATIONSHIP, and ASSIGNMENT.
                                                                                                                                                                                                                    • \n
                                                                                                                                                                                                                  \n

                                                                                                                                                                                                                  When COPY_ACTUALS is not enabled, only the features explicitly set to true are copied, and no automatic group expansion occurs.

                                                                                                                                                                                                                  ", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_RESOURCE_DOCUMENT_KEY:project_resource_copyOptions_description" } }, "priorityNum":{ "maximum":10000, "minimum":1, "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "primaryProgramCode":{ "maxLength":60, "type":"string", "description":"The user-defined identifier of a primary program of a project. This field is intended to be used while updating a project.
                                                                                                                                                                                                                  The value of this field cannot be removed by providing the value as null in the payload. Instead, use the primaryProgramId field with the value null to remove the value from this field.", "exampleSetFlag":false, "types":[ "string" ] }, "projectName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ] }, "actualStart":{ "type":"string", "description":"The Actual Start indicates the date work on the project began.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualFinish":{ "type":"string", "description":"The Actual Finish displays the date on which a project is considered complete.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastFinishDate":{ "type":"string", "description":"The planned finish date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastStartDate":{ "type":"string", "description":"The planned start date of a project's remaining Forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendStartDate":{ "type":"string", "description":"The start date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendFinishDate":{ "type":"string", "description":"The finish date for the project actuals.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsStartDate":{ "type":"string", "description":"The date benefits on the project began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "benefitsFinishDate":{ "type":"string", "description":"The date benefits on the project finished.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendEffectiveDate":{ "type":"string", "description":"The month in which an actuals value was last added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastToSpend":{ "type":"boolean", "description":"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.", "exampleSetFlag":false, "types":[ "boolean" ] }, "forecastLinkType":{ "type":"string", "description":"The type of forecast data linked to a project. Forecast data represents an estimation of a project's remaining costs.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "INTEGRATION" ] }, "plannedBudgetLinkType":{ "type":"string", "description":"Type of data to which a project's planned budget is linked.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "BUDGET", "INTEGRATION" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The estimated percentage of work that has been completed on the project. This value is entered by the user.", "format":"double", "exampleSetFlag":false }, "riskMatrixId":{ "type":"integer", "description":"The risk matrix assigned to the project for calculating project risk scores.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reportCycleId":{ "type":"integer", "description":"The reporting cycle assigned to the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCashFlows":{ "type":"array", "description":"The cash flow of a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectCashFlowInput", "exampleSetFlag":false }, "types":[ "array" ] }, "primaryProgramId":{ "type":"integer", "description":"The system-generated identifier of a primary program of a project. This field is intended to be used while updating a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualLinkType":{ "type":"string", "description":"Type of actuals data linked to a project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "ACTUAL", "INTEGRATION" ] }, "projectSettings":{ "type":"array", "description":"The project settings associated with the project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectSettingInput", "exampleSetFlag":false }, "types":[ "array" ] }, "planEndDate":{ "type":"string", "description":"The finish date for the time phased Planned Budget of the project.
                                                                                                                                                                                                                  Planned Budget cost spread will adjust when this date is changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planStartDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "websiteUrl":{ "maxLength":200, "minLength":0, "type":"string", "description":"The link to a website related to the project.", "exampleSetFlag":false, "types":[ "string" ] }, "dataDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "strgyPriorityNum":{ "maximum":10000, "minimum":1, "type":"integer", "description":"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.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ], "default":500 }, "mustFinishByDate":{ "type":"string", "description":"The latest date on which the scheduled activities must be complete for a project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "linkForecastTo":{ "type":"integer", "description":"Specifies data to which a project forecast is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "linkActualTo":{ "type":"integer", "description":"Specifies data to which project actuals data is linked.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "isTemplateFlag":{ "type":"boolean", "description":"Indicates the project is a template for creating other projects.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exchangeRate":{ "type":"number", "description":"The custom exchange rate for the currency assigned to the project.", "exampleSetFlag":false, "types":[ "number" ] }, "projectIntegrationType":{ "type":"string", "description":"Specifies if the project is integrated with another application.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "P6", "UNIFIER" ] }, "riskLevel":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ] }, "riskScore":{ "type":"integer", "description":"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.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectTimeZone":{ "type":"string", "description":"The time zone of the project's location.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "INTERNATIONAL_DATE_LINE_WEST", "MIDWAY_ISLAND_SAMOA", "HAWAII", "ALASKA", "PACIFIC_TIME", "ARIZONA", "CHIHUAHUA_LA_PAZ_MAZATLAN", "MOUNTAIN_TIME", "CENTRAL_AMERICA", "CENTRAL_TIME", "GUADALAJARA_MEXICO_CITY_MONTERREY", "SASKATCHEWAN", "BOGOTA_LIMA_QUITO", "EASTERN_TIME", "INDIANA", "ATLANTIC_TIME", "CARACAS_LA_PAZ_PUERTO_RICO", "SANTIAGO", "NEWFOUNDLAND", "BRASILIA", "BUENOS_AIRES_GEORGETOWN", "MID_ATLANTIC", "AZORES", "CAPE_VERDE_IS", "CASABLANCA_MONROVIA", "GREENWICH_MEAN_TIME", "AMSTERDAM_BERLIN_BERN", "BELGRADE_BRATISLAVA_BUDAPEST", "BRUSSELS_COPENHAGEN_MADRID", "SARAJEVO_SKOPJE_WARSAW", "WEST_CENTRAL_AFRICA", "ATHENS_BEIRUT_ISTANBUL", "BUCHAREST", "CAIRO", "HARARE_PRETORIA", "HELSINKI_KVIV_RIGA", "JERUSALEM", "BAGHDAD", "KUWAIT_RIYADH", "NAIROBI", "MOSCOW_ST_PETERSBURG", "TEHRAN", "ABU_DHADI_MUSCAT", "BAKU_TBILISI_YEREVAN", "KABUL", "ISLAMABAD_KARACHI_TASHKENT", "CHENNAI_KOLKATA_MUMBAI", "ASTANA_DHAKA", "RANGOON", "BANGKOK_HANOI_JAKARTA", "BEJING_CHONGQING_HONG_KONG", "KUALA_LUMPUR_SINGAPORE", "PERTH", "TAIPEI", "OSAKA_SAPPORO_TOKYO", "SEOUL", "ADELAIDE", "DARWIN", "BRISBANE", "CANBERRA_MELBOURNE_SYDNEY", "GUAM_PORT_MORESBY", "HOBART", "MAGADAN_SOLOMON_IS_NEW_CALEDONIA", "AUCKLAND_WELLINGTON" ] }, "projectCurrency":{ "type":"integer", "description":"The unique identifier of the currency to be used in the project. Currencies configured in the immediate parent workspace, with at least one exchange rate configured, are available to be used in the project. If no value is specified, the parent workspace currency will be selected.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of appearance of projects in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "managerId":{ "type":"integer", "description":"The user id of a manager or person responsible for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarId":{ "type":"integer", "description":"The unique identifier for the calendar.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of a project in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The date on which work on the project starts.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The date on which all project work is complete.
                                                                                                                                                                                                                  This value can be entered manually or can be imported.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "locationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                  This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                  This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "minLength":0, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manager":{ "maxLength":255, "type":"string", "description":"The user name of a manager or person responsible for the project.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"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.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETE" ] } }, "description":"This entity represents a ExternallySourcedProject object, a unique ExternallySourcedProject object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                  • projectId
                                                                                                                                                                                                                  • projectCode,workspaceId
                                                                                                                                                                                                                  • projectCode,workspaceCode
                                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityProjectBudget":{ "title":"ApiEntityProjectBudget", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "withdrawApprovalByUserId":{ "type":"integer", "description":"The user who withdrew approval of the budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "withdrawApprovalByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who withdrew a project budget.", "exampleSetFlag":false, "types":[ "string" ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "submitByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who submitted a project budget.", "exampleSetFlag":false, "types":[ "string" ] }, "submitDate":{ "type":"string", "description":"The date the budget was submitted for review.", "format":"date-time", "exampleSetFlag":false }, "withdrawApprovalDate":{ "type":"string", "description":"The date the approval of the budget is withdrawn.", "format":"date-time", "exampleSetFlag":false }, "approveByUserId":{ "type":"integer", "description":"The user who approved the budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who approved a project budget.", "exampleSetFlag":false, "types":[ "string" ] }, "budgetStatus":{ "type":"string", "description":"The status of the project budget.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "PENDING", "REJECTED", "APPROVED" ] }, "lastModifiedById":{ "type":"integer", "description":"The unique identifier of the user who last modified the project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserId":{ "type":"integer", "description":"The system-generated identifier of the user who rejected the budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rejectByUserName":{ "maxLength":255, "type":"string", "description":"The name of the user who rejected a project budget.", "exampleSetFlag":false, "types":[ "string" ] }, "rejectDate":{ "type":"string", "description":"The date the budget was rejected.", "format":"date-time", "exampleSetFlag":false }, "submitByUserId":{ "type":"integer", "description":"The system-generated identifier of the user who submitted the budget for review.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectBudgetId":{ "type":"integer", "description":"The unique identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "approveDate":{ "type":"string", "description":"The date the project budget was approved.", "format":"date-time", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectBudgetStatusTransitionHistory":{ "title":"ApiEntityProjectBudgetStatusTransitionHistory", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Comments included by the user who changed the status of the record.", "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"The date the status of the record was changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectBudgetStatusTransitionHistoryId":{ "type":"integer", "description":"The system-generated identifier of project budget status transition history.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The name of a user associated with the status change.", "exampleSetFlag":false, "types":[ "string" ] }, "projectBudgetId":{ "type":"integer", "description":"The system-generated identifier of a project budget.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "statusTransitionType":{ "type":"string", "description":"The type of change made to the record.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "REJECT", "DRAFT" ] }, "userId":{ "type":"integer", "description":"The user who changed the status of the record.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCashflowExportProjectIdentifierInput":{ "title":"ApiEntityCashflowExportProjectIdentifierInput", "type":"object", "properties":{ "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a CashflowExportProjectIdentifier object, a unique CashflowExportProjectIdentifier object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                    • projectId
                                                                                                                                                                                                                    • projectCode,workspaceCode
                                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityCashflowExportProjectInput":{ "title":"ApiEntityCashflowExportProjectInput", "required":[ "projectsInfo", "startDate" ], "type":"object", "properties":{ "projectsInfo":{ "type":"array", "description":"List of projects for which to export cashflows in a compressed ZIP file containing a CSV file.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCashflowExportProjectIdentifierInput", "exampleSetFlag":false }, "types":[ "array" ] }, "startDate":{ "type":"string", "description":"Start date of the curve.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "costCurves":{ "type":"array", "description":"List of cost curves to be exported. If omitted or empty, all curves will be exported.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTUALS", "BENEFITS", "FORECAST", "PLANNED_BUDGET", "PORTFOLIO_APPROVED_BUDGET", "PORTFOLIO_PROPOSED_BUDGET" ] }, "types":[ "array" ] }, "endDate":{ "type":"string", "description":"Finish date of the curve. If no value is provided, a maximum of 20 years from the start date is considered as the end date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectDependency":{ "title":"ApiEntityProjectDependency", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "dependentProjectWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of a project that has other projects that it relies on for support.#project invalid inputs", "exampleSetFlag":false, "types":[ "string" ] }, "dependentProjectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of a project that has other projects that it relies on for support.", "exampleSetFlag":false, "types":[ "string" ] }, "projectWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of a project that has other projects depending on it.", "exampleSetFlag":false, "types":[ "string" ] }, "projectDependencyId":{ "type":"integer", "description":"The unique identifier of a project dependency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dependentProjectId":{ "type":"integer", "description":"The unique identifier of a project that has other projects that it relies on for support.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dependencyDescription":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary of the project dependency.
                                                                                                                                                                                                                      The description provides more information than short names or titles.
                                                                                                                                                                                                                      It can give background information or establish a purpose for the item.
                                                                                                                                                                                                                      Dependency Descriptions can help elaborate the reasons for the project dependency.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of a project that has other projects depending on it.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project that has other projects depending on it.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectDependencyInput":{ "title":"ApiEntityProjectDependencyInput", "required":[ "dependentProjectId", "projectId" ], "type":"object", "properties":{ "dependentProjectWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of a project that has other projects that it relies on for support.#project invalid inputs", "exampleSetFlag":false, "types":[ "string" ] }, "dependentProjectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of a project that has other projects that it relies on for support.", "exampleSetFlag":false, "types":[ "string" ] }, "projectWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The workspace code of a project that has other projects depending on it.", "exampleSetFlag":false, "types":[ "string" ] }, "projectDependencyId":{ "type":"integer", "description":"The unique identifier of a project dependency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dependentProjectId":{ "type":"integer", "description":"The unique identifier of a project that has other projects that it relies on for support.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dependencyDescription":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary of the project dependency.
                                                                                                                                                                                                                      The description provides more information than short names or titles.
                                                                                                                                                                                                                      It can give background information or establish a purpose for the item.
                                                                                                                                                                                                                      Dependency Descriptions can help elaborate the reasons for the project dependency.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project code of a project that has other projects depending on it.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project that has other projects depending on it.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProjectDependency object, a unique ProjectDependency object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                      • projectDependencyId
                                                                                                                                                                                                                      • projectId,dependentProjectId
                                                                                                                                                                                                                      • projectId,dependentProjectCode,dependentProjectWorkspaceCode
                                                                                                                                                                                                                      • projectCode,projectWorkspaceCode,dependentProjectId
                                                                                                                                                                                                                      • projectCode,projectWorkspaceCode,dependentProjectCode,dependentProjectWorkspaceCode
                                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityProjectRank":{ "title":"ApiEntityProjectRank", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "evaluationCategoryId":{ "type":"integer", "description":"Evaluation category ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "evaluationSubCategoryId":{ "type":"integer", "description":"Evaluation subcategory ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "evaluationRankId":{ "type":"integer", "description":"The ranking for the evaluation category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "categoryScore":{ "type":"number", "description":"Category score.", "format":"double", "exampleSetFlag":false }, "subCategoryScore":{ "type":"number", "description":"The evaluation score of a project per category and sub-category.
                                                                                                                                                                                                                        The sub-category score formula is calculated as the selected Rank Weight % multiplied by the given sub-category Weight % divided by 100.
                                                                                                                                                                                                                        The category score formula is calculated as the sum of the sub-category Scores. If a given sub-category does not have a score, its score is 0.", "format":"double", "exampleSetFlag":false }, "projectRankId":{ "type":"integer", "description":"The system-generated identifier of the project rank.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier of the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectRankInput":{ "title":"ApiEntityProjectRankInput", "required":[ "evaluationCategoryId", "evaluationRankId", "evaluationSubCategoryId", "projectId" ], "type":"object", "properties":{ "evaluationCategoryId":{ "type":"integer", "description":"Evaluation category ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "evaluationSubCategoryId":{ "type":"integer", "description":"Evaluation subcategory ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "evaluationRankId":{ "type":"integer", "description":"The ranking for the evaluation category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRankId":{ "type":"integer", "description":"The system-generated identifier of the project rank.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier of the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProjectRank object, a unique ProjectRank object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                        • projectRankId
                                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityProjectResourceWorkRate":{ "title":"ApiEntityProjectResourceWorkRate", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectResourceWorkRateId":{ "type":"integer", "description":"The unique identifier of a project work rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectResourceWorkRateCost":{ "description":"An entity containing the price per unit fields of a project resource work rate.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateCost" } ] }, "projectResourceId":{ "type":"integer", "description":"The unique identifier of a project resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "effectiveStartDate":{ "type":"string", "description":"Date that the corresponding units/time period and rates go into effect for the resource or role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "maxUnitsPerTime":{ "type":"number", "description":"Maximum work units per time the resource or role can perform on all their assigned activities.", "format":"double", "exampleSetFlag":false }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a project of a project resource.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a resource of a project resource.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of a workspace of a project resource.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectResourceWorkRateCost":{ "title":"ApiEntityProjectResourceWorkRateCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectResourceWorkRateId":{ "type":"integer", "description":"The unique identifier of a project work rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pricePerUnit1":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities. This field is in base currency and is calculated from pricePerUnit1Project field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pricePerUnit2":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities. This field is in base currency and is calculated from pricePerUnit2Project field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pricePerUnit3":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities. This field is in base currency and is calculated from pricePerUnit3Project field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pricePerUnit4":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities. This field is in base currency and is calculated from pricePerUnit4Project field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pricePerUnit5":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities. This field is in base currency and is calculated from pricePerUnit5Project field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pricePerUnit1Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit2Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit3Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit4Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit5Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectResourceWorkRateCostInput":{ "title":"ApiEntityProjectResourceWorkRateCostInput", "type":"object", "properties":{ "pricePerUnit1Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit2Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit3Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit4Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit5Project":{ "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityProjectResourceWorkRateInput":{ "title":"ApiEntityProjectResourceWorkRateInput", "required":[ "effectiveStartDate", "maxUnitsPerTime", "projectId", "resourceId" ], "type":"object", "properties":{ "projectResourceWorkRateId":{ "type":"integer", "description":"The unique identifier of a project work rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectResourceWorkRateCost":{ "description":"An entity containing the price per unit fields of a project resource work rate.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectResourceWorkRateCostInput" } ] }, "projectResourceId":{ "type":"integer", "description":"The unique identifier of a project resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "effectiveStartDate":{ "type":"string", "description":"Date that the corresponding units/time period and rates go into effect for the resource or role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "maxUnitsPerTime":{ "type":"number", "description":"Maximum work units per time the resource or role can perform on all their assigned activities.", "format":"double", "exampleSetFlag":false }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a project of a project resource.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a resource of a project resource.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of a workspace of a project resource.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ProjectResourceWorkRate object, a unique ProjectResourceWorkRate object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                          • projectResourceWorkRateId
                                                                                                                                                                                                                          • effectiveStartDate,projectResourceId
                                                                                                                                                                                                                          • effectiveStartDate,resourceId,projectCode,workspaceCode
                                                                                                                                                                                                                          • effectiveStartDate,resourceCode,resourceClass,projectId
                                                                                                                                                                                                                          • effectiveStartDate,resourceCode,resourceClass,projectCode,workspaceCode
                                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityCodeValueRisk":{ "title":"ApiEntityCodeValueRisk", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueRiskId":{ "type":"integer", "description":"The unique identifier of a risk code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectRisk":{ "title":"ApiEntityProjectRisk", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "riskQuantifiedCostImpact":{ "description":"The impact this risk will have on cost data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRiskQuantifiedCostImpact" } ] }, "riskQuantifiedOtherImpacts":{ "type":"array", "description":"The impact this risk will have on other data.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskQuantifiedOtherImpact", "exampleSetFlag":false }, "types":[ "array" ] }, "activityImpactQuantified":{ "type":"boolean", "description":"Enabled when activity quantified risk impact is linked to the project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "preResponseMeanCostImpact":{ "type":"number", "description":"The estimated average project cost impact before implementing a response action.", "format":"double", "exampleSetFlag":false }, "postResponseMeanCostImpact":{ "type":"number", "description":"The estimated average project cost impact before implementing a response action.", "format":"double", "exampleSetFlag":false }, "preResponsePessimisticFinishDeltaAbs":{ "type":"number", "description":"The duration difference between the pre-response and post-response pessimistic finish dates.", "format":"double", "exampleSetFlag":false }, "postResponsePessimisticFinishDeltaAbs":{ "type":"number", "description":"The duration difference between the pre-response and post-response pessimistic finish dates.", "format":"double", "exampleSetFlag":false }, "preResponsePessimisticCostDeltaAbs":{ "type":"number", "description":"The cost difference between the Pre-Response and Post-Response remaining cost values.", "format":"double", "exampleSetFlag":false }, "postResponsePessimisticCostDeltaAbs":{ "type":"number", "description":"The cost difference between the Pre-Response and Post-Response remaining cost values.", "format":"double", "exampleSetFlag":false }, "riskMitigationEarliestStartDate":{ "type":"string", "description":"The earliest start date of the risk's response actions.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "riskMitigationRolledUpStatus":{ "type":"string", "description":"The rolled up status of the risk's response actions.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "SANCTIONED", "NOT_STARTED", "REJECTED", "IN_PROGRESS", "COMPLETED" ] }, "excludeFromRiskRemovalAnalysis":{ "type":"boolean", "description":"Determines whether the impact of removing the risk is calculated during risk removal risk analysis.", "exampleSetFlag":false, "types":[ "boolean" ], "default":false }, "riskFactorCostImpactOption":{ "type":"string", "description":"The cost type the risk factor impacts.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ALL_COSTS", "MATERIAL_COSTS_ONLY", "LABOR_COSTS_ONLY", "NONLABOR_COSTS_ONLY", "LABOR_AND_NONLABOR_COSTS_ONLY" ] }, "isRiskFactorImpactedIndependently":{ "type":"boolean", "description":"For a risk factor the option to impact activities independently.", "exampleSetFlag":false, "types":[ "boolean" ] }, "riskMitigationLatestFinishDate":{ "type":"string", "description":"The latest finish date of the risk's response actions.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "riskMitigationFinishAfterExposure":{ "type":"string", "description":"One or more response actions finish after the start of the risk exposure.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TRUE", "FALSE", "MISSING_DATES" ] }, "projectRiskFinancial":{ "description":"The financial fields associated with a project risk.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectRiskFinancial" } ] }, "codeValuesRisk":{ "type":"array", "description":"The list of code values for a project risk. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueRisk", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskStatus":{ "type":"string", "description":"The status of the risk.
                                                                                                                                                                                                                            Proposed: The risk is identified and awaits approval.
                                                                                                                                                                                                                            Open: The risk is approved as a valid risk and is awaiting management.
                                                                                                                                                                                                                            Monitoring: The risk has been managed and is being monitored.
                                                                                                                                                                                                                            Impacting: The risk is currently impacting the project.
                                                                                                                                                                                                                            Cannot Impact: The risk did not happen and can no longer happen.
                                                                                                                                                                                                                            Impacted: The risk occurred.
                                                                                                                                                                                                                            Rejected: The risk is not seen as a valid risk to the project and therefore will not be tracked and managed by the project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "OPEN", "MONITORING", "IMPACTING", "REJECTED", "CANNOT_IMPACT", "IMPACTED" ] }, "costCategoryId":{ "type":"integer", "description":"The category name used to organize and define the cost.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The cost breakdown structure code assigned to the risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMitigationCount":{ "type":"integer", "description":"The number of response actions on the risk.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "exposureStartDate":{ "type":"string", "description":"The earliest start date of the activities that the risk is mapped to. If the risk is not mapped to any activities, it is the date at which the schedule is progressed (Data Date).", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "exposureFinishDate":{ "type":"string", "description":"The latest finish date of the activities the risk is mapped to. If the risk is not mapped to any activities, it is the project scheduled finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project risk.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRiskConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project to which the risk was added.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "impacts":{ "type":"array", "description":"The impact of the risk.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskImpact", "exampleSetFlag":false }, "types":[ "array" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cause":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A description of the cause of the risk.", "exampleSetFlag":false }, "state":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "country":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "quantifiedPostResponseProbabilityThreshold":{ "type":"number", "description":"The probability threshold that a risk will occur after implementing a response action.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scheduleImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "probabilityImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "quantifiedScheduleThreshold":{ "type":"number", "description":"The estimated impact size that the risk will have on the project schedule before implementing a response action.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedProbabilityThreshold":{ "type":"number", "description":"The estimated probability that a risk will occur before implementing a response action.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedPostResponseScheduleThreshold":{ "type":"number", "description":"The estimated impact size that the risk will have on the project schedule after implementing a response action.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary of the risk.", "exampleSetFlag":false }, "hasPostResponseData":{ "type":"boolean", "description":"Determines whether this risk has post-response values.", "exampleSetFlag":false, "types":[ "boolean" ] }, "identifiedDate":{ "type":"string", "description":"The date the risk was added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "riskType":{ "type":"string", "description":"The type of risk. Valid values are Threat, Opportunity, Weather and Risk Factor.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "THREAT", "OPPORTUNITY", "WEATHER", "RISK_FACTOR" ] }, "identifiedById":{ "type":"integer", "description":"The user who added the risk to the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "postScore":{ "type":"integer", "description":"The post-response risk score calculated using the project risk matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "costImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified cost distribution is used to determine the cost impact for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualScheduleImpact":{ "type":"number", "description":"The actual schedule impact due to the risk occurring.", "format":"double", "exampleSetFlag":false }, "impactedDate":{ "type":"string", "description":"The date the risk impacted the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "preResponseMeanDelay":{ "type":"number", "description":"The estimated average project delay duration before implementing a response action.", "format":"double", "exampleSetFlag":false }, "postResponseMeanDelay":{ "type":"number", "description":"The estimated average project delay duration before implementing a response action.", "format":"double", "exampleSetFlag":false }, "locationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                            This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                            This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "riskSourceType":{ "type":"string", "description":"The source type of the risk i.e. Project or Program.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT", "PROGRAM" ] }, "scoreImprovement":{ "type":"integer", "description":"The change in project risk score due to the response action(s).", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "responseEffectiveness":{ "type":"number", "description":"The effectiveness of the risk's response actions expressed as a ratio of the Exposure Improvement and the Total At Completion Response Cost.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "effect":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The resulting effect of the presence of the risk.", "exampleSetFlag":false }, "score":{ "type":"integer", "description":"The pre-response risk score calculated using the project risk matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ownerId":{ "type":"integer", "description":"The name of the user who is assigned to manage the risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "city":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectRiskConfiguredFieldValue":{ "title":"ApiEntityProjectRiskConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Risk Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of a Risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectRiskFinancial":{ "title":"ApiEntityProjectRiskFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "preQuantifiedCostThreshold":{ "type":"number", "description":"The estimated impact size that the risk will have on the project cost before implementing a response action.", "format":"double", "exampleSetFlag":false }, "postQuantifiedCostThreshold":{ "type":"number", "description":"The estimated impact size that the risk will have on the project cost after implementing a response action.", "format":"double", "exampleSetFlag":false }, "actualResponseCostProject":{ "minimum":0, "type":"number", "description":"The actual cost of implementing a response action. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingTotalResponseCost":{ "type":"number", "description":"The total Remaining Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "preRemainingTotalResponseCost":{ "type":"number", "description":"The total Pre-Response Remaining Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "postRemainingTotalResponseCost":{ "type":"number", "description":"The total Post-Response Remaining Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "atCompletionTotalResponseCost":{ "type":"number", "description":"The total At Completion Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "preAtCompletionTotalResponseCost":{ "type":"number", "description":"The total Pre-Response At Completion Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "postAtCompletionTotalResponseCost":{ "type":"number", "description":"The total Post-Response At Completion Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "preResponseExposureWorkspace1":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "preResponseExposureWorkspace2":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "preResponseExposureWorkspace3":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "postResponseExposureWorkspace1":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "postResponseExposureWorkspace2":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "postResponseExposureWorkspace3":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.", "format":"double", "exampleSetFlag":false }, "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "preExposureCost":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This field is in base currency and is calculated from preExposureCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preExposureCostProject":{ "type":"number", "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "postExposureCost":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This field is in base currency and is calculated from postExposureCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postExposureCostProject":{ "type":"number", "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualResponseCost":{ "minimum":0, "type":"number", "description":"The actual cost of implementing the response action. This field is in base currency and is calculated from actualResponseCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostImpact":{ "minimum":0, "type":"number", "description":"The actual cost impact due to the risk occurring.", "format":"double", "exampleSetFlag":false }, "contingency":{ "minimum":0, "type":"number", "description":"The allowable risk cost should the risk occur.", "format":"double", "exampleSetFlag":false }, "preActualResponseCost":{ "type":"number", "description":"The total Pre-Response Actual Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "postActualResponseCost":{ "type":"number", "description":"The total Post-Response Actual Response Cost of the risk.", "format":"double", "exampleSetFlag":false }, "exposureImprovementCost":{ "type":"number", "description":"The difference between the Pre-Response Exposure and the Post-Response Exposure.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskImpact":{ "title":"ApiEntityRiskImpact", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated unique identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postRiskScoreThresholdId":{ "type":"integer", "description":"The system-generated unique identifier for the post-response impact threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postRiskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk scoring threshold.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreThresholdId":{ "type":"integer", "description":"The system-generated unique identifier for the pre-response impact threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the risk score threshold of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "riskImpactId":{ "type":"integer", "description":"A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The risk score type name of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The system-generated unique identifier of the risk score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The project risk code of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskQuantifiedCostImpact":{ "title":"ApiEntityRiskQuantifiedCostImpact", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "preResponseDistributionShape":{ "type":"string", "description":"Determines the distribution that best models the three-point estimates for the cost impact before a response. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "postResponseDistributionShape":{ "type":"string", "description":"Determines the distribution that best models the three-point estimates for the cost impact after a response.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "preResponseMinimumProject":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "preResponseMinimumWorkspace1":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMinimumWorkspace2":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMinimumWorkspace3":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikelyProject":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikelyWorkspace1":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikelyWorkspace2":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikelyWorkspace3":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMaximumProject":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "preResponseMaximumWorkspace1":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMaximumWorkspace2":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "preResponseMaximumWorkspace3":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMinimumProject":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "postResponseMinimumWorkspace1":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMinimumWorkspace2":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMinimumWorkspace3":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikelyProject":{ "type":"number", "description":"The most likely cost of a risk event that has occurred. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikelyWorkspace1":{ "type":"number", "description":"The most likely cost of a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikelyWorkspace2":{ "type":"number", "description":"The most likely cost of a risk event that has occurred.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikelyWorkspace3":{ "type":"number", "description":"The most likely probability that a risk event will occur.", "format":"double", "exampleSetFlag":false }, "postResponseMaximumProject":{ "type":"number", "description":"The maximum cost of responding to a risk event. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "postResponseMaximumWorkspace1":{ "type":"number", "description":"The maximum cost of responding to a risk event.", "format":"double", "exampleSetFlag":false }, "postResponseMaximumWorkspace2":{ "type":"number", "description":"The maximum cost of responding to a risk event.", "format":"double", "exampleSetFlag":false }, "postResponseMaximumWorkspace3":{ "type":"number", "description":"The maximum cost of responding to a risk event.", "format":"double", "exampleSetFlag":false }, "preResponseMinimum":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMinimumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikely":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMostLikelyProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preResponseMaximum":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMaximumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMinimum":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred. This field is in base currency and is calculated from postResponseMinimumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikely":{ "type":"number", "description":"The most likely cost of a risk event that has occurred. This field is in base currency and is calculated from postResponseMostLikelyProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMaximum":{ "type":"number", "description":"The maximum cost of responding to a risk event. This field is in base currency and is calculated from postResponseMaximumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "quantifiedCostImpactId":{ "type":"integer", "description":"The unique identifier of a cost impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskQuantifiedOtherImpact":{ "title":"ApiEntityRiskQuantifiedOtherImpact", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "shape":{ "type":"string", "description":"The distribution that best models the three-point estimates for risk probabilities or risk schedule impacts.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "minimum":{ "type":"number", "description":"The minimum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "maximum":{ "type":"number", "description":"The maximum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedOtherImpactId":{ "type":"integer", "description":"The unique identifier of a risk impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scoreType":{ "type":"string", "description":"The type of an impact score.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ] }, "mostLikely":{ "type":"number", "description":"The most likely probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "preOrPostResponse":{ "type":"string", "description":"Indicates whether a risk impact is measured pre or post response.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_RESPONSE", "POST_RESPONSE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueRiskInput":{ "title":"ApiEntityCodeValueRiskInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueRiskId":{ "type":"integer", "description":"The unique identifier of a risk code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueRisk object, a unique CodeValueRisk object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                            • codeValueRiskId
                                                                                                                                                                                                                            • codeValueId
                                                                                                                                                                                                                            • codeTypeId,codeValueCode
                                                                                                                                                                                                                            • codeTypeCode,codeValueCode
                                                                                                                                                                                                                            • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                                            • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                            • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                                            • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                                            • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                                            • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityProjectRiskConfiguredFieldValueInput":{ "title":"ApiEntityProjectRiskConfiguredFieldValueInput", "type":"object", "properties":{ "projectRiskConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Risk Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of a Risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ProjectRiskConfiguredFieldValue object, a unique ProjectRiskConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                              • projectRiskConfiguredFieldValueId
                                                                                                                                                                                                                              • columnDefinitionId
                                                                                                                                                                                                                              • columnName
                                                                                                                                                                                                                              • columnLabel
                                                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityProjectRiskFinancialInput":{ "title":"ApiEntityProjectRiskFinancialInput", "required":[ "projectRiskId" ], "type":"object", "properties":{ "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualCostImpact":{ "minimum":0, "type":"number", "description":"The actual cost impact due to the risk occurring.", "format":"double", "exampleSetFlag":false }, "contingency":{ "minimum":0, "type":"number", "description":"The allowable risk cost should the risk occur.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityProjectRiskInput":{ "title":"ApiEntityProjectRiskInput", "required":[ "projectId", "riskName" ], "type":"object", "properties":{ "riskQuantifiedCostImpact":{ "description":"The impact this risk will have on cost data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRiskQuantifiedCostImpactInput" } ] }, "riskQuantifiedOtherImpacts":{ "type":"array", "description":"The impact this risk will have on other data.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskQuantifiedOtherImpactInput", "exampleSetFlag":false }, "types":[ "array" ] }, "excludeFromRiskRemovalAnalysis":{ "type":"boolean", "description":"Determines whether the impact of removing the risk is calculated during risk removal risk analysis.", "exampleSetFlag":false, "types":[ "boolean" ], "default":false }, "riskFactorCostImpactOption":{ "type":"string", "description":"The cost type the risk factor impacts.", "exampleSetFlag":false, "types":[ "string" ], "default":"ALL_COSTS", "enum":[ "ALL_COSTS", "MATERIAL_COSTS_ONLY", "LABOR_COSTS_ONLY", "NONLABOR_COSTS_ONLY", "LABOR_AND_NONLABOR_COSTS_ONLY" ] }, "projectRiskFinancial":{ "description":"The financial fields associated with a project risk.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectRiskFinancialInput" } ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "writeOnly":true, "exampleSetFlag":false, "items":{ "type":"string", "writeOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "codeValuesRisk":{ "type":"array", "description":"The list of code values for a project risk. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueRiskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskStatus":{ "type":"string", "description":"The status of the risk.
                                                                                                                                                                                                                                Proposed: The risk is identified and awaits approval.
                                                                                                                                                                                                                                Open: The risk is approved as a valid risk and is awaiting management.
                                                                                                                                                                                                                                Monitoring: The risk has been managed and is being monitored.
                                                                                                                                                                                                                                Impacting: The risk is currently impacting the project.
                                                                                                                                                                                                                                Cannot Impact: The risk did not happen and can no longer happen.
                                                                                                                                                                                                                                Impacted: The risk occurred.
                                                                                                                                                                                                                                Rejected: The risk is not seen as a valid risk to the project and therefore will not be tracked and managed by the project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "OPEN", "MONITORING", "IMPACTING", "REJECTED", "CANNOT_IMPACT", "IMPACTED" ] }, "costCategoryId":{ "type":"integer", "description":"The category name used to organize and define the cost.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The cost breakdown structure code assigned to the risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a project risk.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProjectRiskConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project to which the risk was added.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "impacts":{ "type":"array", "description":"The impact of the risk.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskImpactInput", "exampleSetFlag":false }, "types":[ "array" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cause":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A description of the cause of the risk.", "exampleSetFlag":false }, "state":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "country":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "scheduleImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "probabilityImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary of the risk.", "exampleSetFlag":false }, "hasPostResponseData":{ "type":"boolean", "description":"Determines whether this risk has post-response values.", "exampleSetFlag":false, "types":[ "boolean" ] }, "identifiedDate":{ "type":"string", "description":"The date the risk was added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "riskType":{ "type":"string", "description":"The type of risk. Valid values are Threat, Opportunity, Weather and Risk Factor.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "THREAT", "OPPORTUNITY", "WEATHER", "RISK_FACTOR" ] }, "identifiedById":{ "type":"integer", "description":"The user who added the risk to the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "costImpactQuantified":{ "type":"boolean", "description":"When selected, the quantified cost distribution is used to determine the cost impact for each iteration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualScheduleImpact":{ "type":"number", "description":"The actual schedule impact due to the risk occurring.", "format":"double", "exampleSetFlag":false }, "impactedDate":{ "type":"string", "description":"The date the risk impacted the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "locationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"A name for the location that your users will understand and recognize.", "exampleSetFlag":false, "types":[ "string" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                                This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                                This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "effect":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The resulting effect of the presence of the risk.", "exampleSetFlag":false }, "ownerId":{ "type":"integer", "description":"The name of the user who is assigned to manage the risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "city":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ProjectRisk object, a unique ProjectRisk object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                • projectRiskId
                                                                                                                                                                                                                                • riskCode,projectId
                                                                                                                                                                                                                                • riskCode,projectCode,workspaceCode
                                                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityRiskImpactInput":{ "title":"ApiEntityRiskImpactInput", "required":[ "projectRiskId", "riskScoreThresholdId", "riskScoreTypeId" ], "type":"object", "properties":{ "projectRiskId":{ "type":"integer", "description":"The system-generated unique identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postRiskScoreThresholdId":{ "type":"integer", "description":"The system-generated unique identifier for the post-response impact threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "postRiskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk scoring threshold.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreThresholdId":{ "type":"integer", "description":"The system-generated unique identifier for the pre-response impact threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the risk score threshold of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "riskImpactId":{ "type":"integer", "description":"A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The risk score type name of a risk impact.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The system-generated unique identifier of the risk score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRiskQuantifiedCostImpactInput":{ "title":"ApiEntityRiskQuantifiedCostImpactInput", "required":[ "preResponseDistributionShape", "projectRiskId" ], "type":"object", "properties":{ "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "preResponseDistributionShape":{ "type":"string", "description":"Determines the distribution that best models the three-point estimates for the cost impact before a response. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "postResponseDistributionShape":{ "type":"string", "description":"Determines the distribution that best models the three-point estimates for the cost impact after a response.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "preResponseMinimum":{ "type":"number", "description":"The minimum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMinimumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preResponseMostLikely":{ "type":"number", "description":"The most likely cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMostLikelyProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "preResponseMaximum":{ "type":"number", "description":"The maximum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMaximumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMinimum":{ "type":"number", "description":"The minimum cost of responding to a risk event that has occurred. This field is in base currency and is calculated from postResponseMinimumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMostLikely":{ "type":"number", "description":"The most likely cost of a risk event that has occurred. This field is in base currency and is calculated from postResponseMostLikelyProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "postResponseMaximum":{ "type":"number", "description":"The maximum cost of responding to a risk event. This field is in base currency and is calculated from postResponseMaximumProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "quantifiedCostImpactId":{ "type":"integer", "description":"The unique identifier of a cost impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRiskQuantifiedOtherImpactInput":{ "title":"ApiEntityRiskQuantifiedOtherImpactInput", "required":[ "projectRiskId", "quantifiedOtherImpactId", "shape" ], "type":"object", "properties":{ "projectRiskId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "shape":{ "type":"string", "description":"The distribution that best models the three-point estimates for risk probabilities or risk schedule impacts.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "minimum":{ "type":"number", "description":"The minimum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "maximum":{ "type":"number", "description":"The maximum probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "quantifiedOtherImpactId":{ "type":"integer", "description":"The unique identifier of a risk impact.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scoreType":{ "type":"string", "description":"The type of an impact score.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ] }, "mostLikely":{ "type":"number", "description":"The most likely probability that a risk event will occur.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "preOrPostResponse":{ "type":"string", "description":"Indicates whether a risk impact is measured pre or post response.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PRE_RESPONSE", "POST_RESPONSE" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMitigation":{ "title":"ApiEntityRiskMitigation", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "riskMitigationFinancial":{ "description":"The financial fields associated with a risk mitigation.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRiskMitigationFinancial" } ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMitigationCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMitigationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The system-generated identifier of the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary of the risk mitigation.", "exampleSetFlag":false }, "mitigationStatus":{ "type":"string", "description":"The status of the risk response action item.
                                                                                                                                                                                                                                  Proposed: The response action has been proposed.
                                                                                                                                                                                                                                  Sanctioned: The response action has been sanctioned.
                                                                                                                                                                                                                                  Not Started: The response action has not started.
                                                                                                                                                                                                                                  In Progress: The response action has started but has not been completed.
                                                                                                                                                                                                                                  Completed: The response action has been completed.
                                                                                                                                                                                                                                  Rejected: The response action has been rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "SANCTIONED", "NOT_STARTED", "REJECTED", "IN_PROGRESS", "COMPLETED" ] }, "activityAssigned":{ "type":"boolean", "description":"Indicates whether an activity is assigned to the response action.", "exampleSetFlag":false, "types":[ "boolean" ] }, "finishAfterExposure":{ "type":"string", "description":"Indicates whether the response action finishes after the start of exposure to the risk.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TRUE", "FALSE", "MISSING_DATES" ] }, "uniqueCode":{ "maxLength":128, "type":"string", "description":"A unique identifier for each Risk Mitigation per project that consists of the parent Risk Code followed by the Risk Mitigation Code.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinishDate":{ "type":"string", "description":"The latest scheduled finish date of all the risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedStartDate":{ "type":"string", "description":"The earliest scheduled start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The earliest start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The latest finish date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "timing":{ "type":"string", "description":"Indicates whether the response action start or finish is before today's date.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "STARTING_LATE", "FINISHING_LATE", "MISSING_DATES" ] }, "ownerId":{ "type":"integer", "description":"The name of the resource responsible for the risk response action item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMitigationFinancial":{ "title":"ApiEntityRiskMitigationFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "preResponseRemainingTotalCost":{ "type":"number", "description":"The response action Pre-Response Remaining Cost.", "format":"double", "exampleSetFlag":false }, "preResponseAtCompletionCost":{ "type":"number", "description":"The response action Pre-Response At Completion Cost.", "format":"double", "exampleSetFlag":false }, "postResponseRemainingTotalCost":{ "type":"number", "description":"The response action Post-Response Remaining Cost.", "format":"double", "exampleSetFlag":false }, "postResponseAtCompletionTotalCost":{ "type":"number", "description":"The response action Post-Response At Completion Cost.", "format":"double", "exampleSetFlag":false }, "riskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "preResponseActualCost":{ "type":"number", "description":"The response action Pre-Response Actual Cost.", "format":"double", "exampleSetFlag":false }, "postResponseActualCost":{ "type":"number", "description":"The response action Post-Response Actual Cost. ", "format":"double", "exampleSetFlag":false }, "actualCost":{ "type":"number", "description":"The response action Actual Cost.", "format":"double", "exampleSetFlag":false }, "remainingTotalCost":{ "type":"number", "description":"The response action Remaining Cost.", "format":"double", "exampleSetFlag":false }, "atCompletionTotalCost":{ "type":"number", "description":"The response action At Completion Cost.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskWeatherPeriod":{ "title":"ApiEntityRiskWeatherPeriod", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "riskWeatherPeriodId":{ "type":"integer", "description":"The system-generated identifier for the period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of a Risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the period.", "exampleSetFlag":false, "types":[ "string" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "shape":{ "type":"string", "description":"The probability distribution that best models the estimates for non-working days in the period. Valid values are Triangle and Uniform. If the value is Uniform, the required fields are minimum and maximum non-working days. If the value is Triangle, the required fields are minimum, maximum, and most-likely non-working days.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "mostLikelyNonWorkingDays":{ "type":"integer", "description":"The most likely number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "nonWorkingDaysPercentage":{ "type":"number", "description":"The percentage of non-working days in the period.", "format":"double", "exampleSetFlag":false }, "nonWorkingTimeDefinitionType":{ "type":"string", "description":"The method used to define the weather risk's non-working time. Valid values are Percentage and Distribution. If the value is Percentage, the required fields are non-working persistence and non-working days percentage. If the value is Distribution, the required fields are shape, minimum non-working days, most-likely non-working days, and maximum non-working days.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PERCENTAGE", "DISTRIBUTION" ] }, "periodStart":{ "type":"string", "description":"The start date of the period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "periodFinish":{ "type":"string", "description":"The finish date of the period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "minNonWorkingDays":{ "type":"integer", "description":"The minimum number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "maxNonWorkingDays":{ "type":"integer", "description":"The maximum number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "nonWorkingPersistence":{ "type":"number", "description":"The probability of a non-working day following another non-working day in the period.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectsAggregate":{ "title":"ApiEntityProjectsAggregate", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectAggregateFinancial":{ "description":"A project's aggregated cost information.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityProjectsAggregateFinancial" } ] }, "projectsAggregateId":{ "type":"integer", "description":"The unique identifier of a rollup. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rollupType":{ "type":"string", "description":"The type of rollup.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT_2_CAPITAL_PLAN", "PROJECT_PORTFOLIO" ] }, "referenceObjectId":{ "type":"integer", "description":"The unique identifier of a project cost reference.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedDuration":{ "type":"number", "description":"The duration between project planned start and project planned finish.", "format":"double", "exampleSetFlag":false }, "recordCount":{ "type":"integer", "description":"The number of comments on a project.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "forecastFinishDate":{ "type":"string", "description":"The planned finish date of a project's remaining forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "forecastStartDate":{ "type":"string", "description":"The planned start date of a project's remaining forecast cost.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "spendEffectiveDate":{ "type":"string", "description":"The month in which an actuals value was last added to the project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planEndDate":{ "type":"string", "description":"The finish date for the time phased planned budget of the project. Planned budget cost spread will adjust when this date is changed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "planStartDate":{ "type":"string", "description":"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.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "startDateVariance":{ "type":"number", "description":"The duration between the project's start date and default snapshot.", "format":"double", "exampleSetFlag":false }, "finishDateVariance":{ "type":"number", "description":"The duration between the project's finish date and default snapshot.", "format":"double", "exampleSetFlag":false }, "startDate":{ "type":"string", "description":"The date on which work on the project begins.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The date on which work on the project ends.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingDuration":{ "type":"number", "description":"The duration between the project start and project finish.", "format":"double", "exampleSetFlag":false }, "actualDuration":{ "type":"number", "description":"The total working time between the project actual start and actual finish.", "format":"double", "exampleSetFlag":false }, "actualFinishDate":{ "type":"string", "description":"The date on which a project is considered complete.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualStartDate":{ "type":"string", "description":"Indicates the date work on the project began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectsAggregateFinancial":{ "title":"ApiEntityProjectsAggregateFinancial", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "proposedBudgetBaseDistributed":{ "type":"number", "description":"The proposed budget allocated to a project.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBaseUndistributed":{ "type":"number", "description":"The proposed budget allocated to a project.", "format":"double", "exampleSetFlag":false }, "plannedBudgetDistributed":{ "type":"number", "description":"The planned total cost of a project.", "format":"double", "exampleSetFlag":false }, "plannedBudgetUndistributed":{ "type":"number", "description":"The planned total cost of a project.", "format":"double", "exampleSetFlag":false }, "forecastCostUndistributed":{ "type":"number", "description":"The total estimation of a project's remaining costs.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetDistributed":{ "type":"number", "description":"The budget currently approved for the project. Current approved budget values are derived from the proposed budget set by the budget planner. A proposed budget becomes the approved budget after the budget scenario has undergone the approval process.", "format":"double", "exampleSetFlag":false }, "currentApprovedBudgetUndistributed":{ "type":"number", "description":"The budget currently approved for the project. Current approved budget values are derived from the proposed budget. A proposed budget becomes an approved budget after the budget scenario has undergone the approval process.", "format":"double", "exampleSetFlag":false }, "proposedForecastVar":{ "type":"number", "description":"The total and time phased variance between the project's proposed budget and forecast.", "format":"double", "exampleSetFlag":false }, "spendPlannedVar":{ "type":"number", "description":"The variance between a project's actual cost and planned budget.", "format":"double", "exampleSetFlag":false }, "currApprSpendVar":{ "type":"number", "description":"The variance between a project's approved budget and actual cost.", "format":"double", "exampleSetFlag":false }, "proposedBudgetBase":{ "type":"number", "description":"The proposed budget allocated to a project.", "format":"double", "exampleSetFlag":false }, "proposedPlannedVar":{ "type":"number", "description":"The total and time phased variance between the project's proposed budget and planned budget.", "format":"double", "exampleSetFlag":false }, "forecastCurrApprVar":{ "type":"number", "description":"The total and time phased variance between the project's forecast and approved budget.", "format":"double", "exampleSetFlag":false }, "projectsAggregateId":{ "type":"integer", "description":"The unique identifier of a rollup.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "rollupType":{ "type":"string", "description":"The type of rollup.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT_2_CAPITAL_PLAN", "PROJECT_PORTFOLIO" ] }, "referenceObjectId":{ "type":"integer", "description":"The unique identifier of a project cost reference.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualCost":{ "type":"number", "description":"Total costs accrued on a project within a given time period.", "format":"double", "exampleSetFlag":false }, "spendForecastVar":{ "type":"number", "description":"The variance between a project's actual cost and forecast.", "format":"double", "exampleSetFlag":false }, "ytdSpendCost":{ "type":"number", "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date.", "format":"double", "exampleSetFlag":false }, "costVariance":{ "type":"number", "description":"The measure of cost performance on a project.", "format":"double", "exampleSetFlag":false }, "forecastCost":{ "type":"number", "description":"The total estimation of a project's remaining costs.", "format":"double", "exampleSetFlag":false }, "plannedBudget":{ "type":"number", "description":"The planned total cost of a project. ", "format":"double", "exampleSetFlag":false }, "currentApprovedBudget":{ "type":"number", "description":"The budget currently approved for the project. Current approved budget values are derived from the proposed budget.", "format":"double", "exampleSetFlag":false }, "yearEndForecastCost":{ "type":"number", "description":"Total forecast at the end of year actuals till date, with respect to the current year.", "format":"double", "exampleSetFlag":false }, "spendCost":{ "type":"number", "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the cost of invoices, payments, or accruals.", "format":"double", "exampleSetFlag":false }, "plannedValueCost":{ "type":"number", "description":"The amount of approved capital spent on a scheduled portion of work on a project.", "format":"double", "exampleSetFlag":false }, "earnedValueCost":{ "type":"number", "description":"The value of work performed on a project in reference to the approved budget for the project.", "format":"double", "exampleSetFlag":false }, "forecastCostDistributed":{ "type":"number", "description":"The total estimation of a project's remaining costs.", "format":"double", "exampleSetFlag":false }, "estAtCompleteCost":{ "type":"number", "description":"The expected total cost of the project when the defined scope of work will be completed.", "format":"double", "exampleSetFlag":false }, "estToCompleteCost":{ "type":"number", "description":"The estimated cost needed to complete the project.", "format":"double", "exampleSetFlag":false }, "scheduleVariance":{ "type":"number", "description":"The measure of schedule performance on a project.", "format":"double", "exampleSetFlag":false }, "netPresentValue":{ "type":"number", "description":"The difference between the present value (PV) of the future cash flows from current investments and project costs.", "format":"double", "exampleSetFlag":false }, "costPerfIndex":{ "type":"number", "description":"The measure of a project's cost efficiency.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "schedPerfIndex":{ "type":"number", "description":"The measure of work accomplished as a percentage of the work scheduled on a project.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "paybackPeriod":{ "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "profitabilityIndex":{ "type":"number", "description":"The index based on the value of a project's present values divided by initial project investments.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "remainingCost":{ "type":"number", "description":"The remaining total cost for the project, including labor resources, nonlabor resources, and project expenses.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The at completion total cost from a cost-loaded P6 schedule.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueResource":{ "title":"ApiEntityCodeValueResource", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueResourceId":{ "type":"integer", "description":"The unique identifier of the resource assigned to the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource assigned to the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResource":{ "title":"ApiEntityResource", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "calendar":{ "type":"integer", "description":"The calendar assigned to the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValuesResource":{ "type":"array", "description":"The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueResource", "exampleSetFlag":false }, "types":[ "array" ] }, "resourceName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information for the resource or the role.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "parentId":{ "type":"integer", "description":"The unique identifier for the parent resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceType":{ "type":"string", "description":"The resource type. Valid values are:
                                                                                                                                                                                                                                  Labor: Indicates that the selected resource performs labor, measured in units of time.
                                                                                                                                                                                                                                  Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource.
                                                                                                                                                                                                                                  Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LABOR", "NONLABOR", "MATERIAL" ] }, "resourceStatus":{ "type":"string", "description":"Determines whether the resource or role is currently active.
                                                                                                                                                                                                                                  Inactive resources might have left the organization, but are not deleted from the system because they might have been assigned an activity in the past or have incurred actual hours.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "resourceTitleName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The job title for the resource.
                                                                                                                                                                                                                                  For example, a resource may have the title Senior Engineer.", "exampleSetFlag":false, "types":[ "string" ] }, "emailAddress":{ "maxLength":255, "minLength":0, "type":"string", "description":"The email address for the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "officePhoneNumber":{ "maxLength":32, "minLength":0, "type":"string", "description":"The office phone number for the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "otherPhoneNumber":{ "maxLength":32, "minLength":0, "type":"string", "description":"The alternate phone numbers for the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "employeeNumber":{ "maxLength":60, "minLength":0, "type":"string", "description":"The resource identifier within the organization, typically the employee number or social security number.", "exampleSetFlag":false, "types":[ "string" ] }, "parentResourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The parent resource code of a resource.", "exampleSetFlag":false, "types":[ "string" ] }, "costQuantityType":{ "type":"string", "description":"The type of costs associated with a resource.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ] }, "unitOfMeasureCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The abbreviation for the unit of measure name.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "defaultUnitsPerHour":{ "type":"number", "description":"The default unit/time is the maximum work units per time a resource or role can perform on all their assigned activities. The value is shown as either a percentage or units/duration depending on the user settings. If the Resource Type is Material, then units/duration are always displayed.
                                                                                                                                                                                                                                  For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day, which is represented as 100%.", "format":"double", "exampleSetFlag":false }, "resourceOwnershipType":{ "type":"string", "description":"The type of ownership for a resource. Possible values include Workspace and Project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE", "PROJECT" ] }, "projectAssociationType":{ "type":"string", "description":"The type of association in the relationship between the resource and the project. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "overtimeFactor":{ "type":"number", "description":"The overtime factor used to compute the overtime price for the resource.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "resourceRoleId":{ "type":"integer", "description":"The identifier for the role assigned to the resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceManagerId":{ "type":"integer", "description":"The person designated as the manager for the resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "applicationUserId":{ "type":"integer", "description":"The name of the user in the application that is also a resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of resource data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceName":{ "maxLength":255, "minLength":1, "type":"string", "description":"Name of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the resource and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                                  This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                                  This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "minLength":0, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unit of measure used for the material resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueResourceInput":{ "title":"ApiEntityCodeValueResourceInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueResourceId":{ "type":"integer", "description":"The unique identifier of the resource assigned to the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource assigned to the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueResource object, a unique CodeValueResource object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                  • codeValueResourceId
                                                                                                                                                                                                                                  • codeValueId
                                                                                                                                                                                                                                  • codeTypeId,codeValueCode
                                                                                                                                                                                                                                  • codeTypeCode,codeValueCode
                                                                                                                                                                                                                                  • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                                                  • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                                  • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                                                  • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                                                  • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                                                  • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityResourceInput":{ "title":"ApiEntityResourceInput", "required":[ "resourceClass", "resourceCode", "resourceStatus", "resourceType", "workspaceId" ], "type":"object", "properties":{ "calendar":{ "type":"integer", "description":"The calendar assigned to the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValuesResource":{ "type":"array", "description":"The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueResourceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "resourceName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information for the resource or the role.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "parentId":{ "type":"integer", "description":"The unique identifier for the parent resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceType":{ "type":"string", "description":"The resource type. Valid values are:
                                                                                                                                                                                                                                    Labor: Indicates that the selected resource performs labor, measured in units of time.
                                                                                                                                                                                                                                    Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource.
                                                                                                                                                                                                                                    Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LABOR", "NONLABOR", "MATERIAL" ] }, "resourceStatus":{ "type":"string", "description":"Determines whether the resource or role is currently active.
                                                                                                                                                                                                                                    Inactive resources might have left the organization, but are not deleted from the system because they might have been assigned an activity in the past or have incurred actual hours.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "resourceTitleName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The job title for the resource.
                                                                                                                                                                                                                                    For example, a resource may have the title Senior Engineer.", "exampleSetFlag":false, "types":[ "string" ] }, "emailAddress":{ "maxLength":255, "minLength":0, "type":"string", "description":"The email address for the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "officePhoneNumber":{ "maxLength":32, "minLength":0, "type":"string", "description":"The office phone number for the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "otherPhoneNumber":{ "maxLength":32, "minLength":0, "type":"string", "description":"The alternate phone numbers for the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "employeeNumber":{ "maxLength":60, "minLength":0, "type":"string", "description":"The resource identifier within the organization, typically the employee number or social security number.", "exampleSetFlag":false, "types":[ "string" ] }, "parentResourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The parent resource code of a resource.", "exampleSetFlag":false, "types":[ "string" ] }, "costQuantityType":{ "type":"string", "description":"The type of costs associated with a resource.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ] }, "unitOfMeasureCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The abbreviation for the unit of measure name.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "defaultUnitsPerHour":{ "type":"number", "description":"The default unit/time is the maximum work units per time a resource or role can perform on all their assigned activities. The value is shown as either a percentage or units/duration depending on the user settings. If the Resource Type is Material, then units/duration are always displayed.
                                                                                                                                                                                                                                    For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day, which is represented as 100%.", "format":"double", "exampleSetFlag":false }, "resourceOwnershipType":{ "type":"string", "description":"The type of ownership for a resource. Possible values include Workspace and Project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE", "PROJECT" ] }, "overtimeFactor":{ "type":"number", "description":"The overtime factor used to compute the overtime price for the resource.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "resourceRoleId":{ "type":"integer", "description":"The identifier for the role assigned to the resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceManagerId":{ "type":"integer", "description":"The person designated as the manager for the resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "applicationUserId":{ "type":"integer", "description":"The name of the user in the application that is also a resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of resource data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                                    This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                                    This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "minLength":0, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unit of measure used for the material resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a Resource object, a unique Resource object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                    • resourceId
                                                                                                                                                                                                                                    • resourceCode,resourceClass,workspaceId
                                                                                                                                                                                                                                    • resourceCode,resourceClass,workspaceCode
                                                                                                                                                                                                                                    • resourceCode,resourceClass,projectId
                                                                                                                                                                                                                                    • resourceCode,resourceClass,projectCode,workspaceCode
                                                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityExternallySourcedResourceInput":{ "title":"ApiEntityExternallySourcedResourceInput", "required":[ "resourceClass", "resourceCode", "resourceStatus", "resourceType", "workspaceId" ], "type":"object", "properties":{ "resourceRoleAssignments":{ "type":"array", "description":"The role assignment associated with the resource.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceRoleAssignmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "resourceWorkRates":{ "type":"array", "description":"The work rates of the resource.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceWorkRateInput", "exampleSetFlag":false }, "types":[ "array" ] }, "managerName":{ "maxLength":255, "type":"string", "description":"The name of the manager associated with the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "user":{ "description":"The user associated with the resource.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityExternallySourcedUser" } ] }, "isUser":{ "type":"boolean", "description":"Indicates whether or not this resource is an application user.", "exampleSetFlag":false, "types":[ "boolean" ] }, "calendar":{ "type":"integer", "description":"The calendar assigned to the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValuesResource":{ "type":"array", "description":"The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueResourceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "resourceName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional information for the resource or the role.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "parentId":{ "type":"integer", "description":"The unique identifier for the parent resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceType":{ "type":"string", "description":"The resource type. Valid values are:
                                                                                                                                                                                                                                      Labor: Indicates that the selected resource performs labor, measured in units of time.
                                                                                                                                                                                                                                      Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource.
                                                                                                                                                                                                                                      Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LABOR", "NONLABOR", "MATERIAL" ] }, "resourceStatus":{ "type":"string", "description":"Determines whether the resource or role is currently active.
                                                                                                                                                                                                                                      Inactive resources might have left the organization, but are not deleted from the system because they might have been assigned an activity in the past or have incurred actual hours.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "resourceTitleName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The job title for the resource.
                                                                                                                                                                                                                                      For example, a resource may have the title Senior Engineer.", "exampleSetFlag":false, "types":[ "string" ] }, "emailAddress":{ "maxLength":255, "minLength":0, "type":"string", "description":"The email address for the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "officePhoneNumber":{ "maxLength":32, "minLength":0, "type":"string", "description":"The office phone number for the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "otherPhoneNumber":{ "maxLength":32, "minLength":0, "type":"string", "description":"The alternate phone numbers for the resource.", "exampleSetFlag":false, "types":[ "string" ] }, "employeeNumber":{ "maxLength":60, "minLength":0, "type":"string", "description":"The resource identifier within the organization, typically the employee number or social security number.", "exampleSetFlag":false, "types":[ "string" ] }, "parentResourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The parent resource code of a resource.", "exampleSetFlag":false, "types":[ "string" ] }, "costQuantityType":{ "type":"string", "description":"The type of costs associated with a resource.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ] }, "unitOfMeasureCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The abbreviation for the unit of measure name.", "exampleSetFlag":false, "types":[ "string" ] }, "calendarCode":{ "maxLength":255, "minLength":0, "type":"string", "description":"The unique code for the calendar.", "exampleSetFlag":false, "types":[ "string" ] }, "defaultUnitsPerHour":{ "type":"number", "description":"The default unit/time is the maximum work units per time a resource or role can perform on all their assigned activities. The value is shown as either a percentage or units/duration depending on the user settings. If the Resource Type is Material, then units/duration are always displayed.
                                                                                                                                                                                                                                      For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day, which is represented as 100%.", "format":"double", "exampleSetFlag":false }, "resourceOwnershipType":{ "type":"string", "description":"The type of ownership for a resource. Possible values include Workspace and Project.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE", "PROJECT" ] }, "overtimeFactor":{ "type":"number", "description":"The overtime factor used to compute the overtime price for the resource.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "resourceRoleId":{ "type":"integer", "description":"The identifier for the role assigned to the resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceManagerId":{ "type":"integer", "description":"The person designated as the manager for the resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "applicationUserId":{ "type":"integer", "description":"The name of the user in the application that is also a resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceId":{ "maxLength":255, "type":"string", "description":"The unique identifier of resource data in an external source.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"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.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "addressLine1":{ "maxLength":200, "minLength":0, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                                      This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "minLength":0, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                                      This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The city name for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "minLength":0, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateCode":{ "maxLength":2, "minLength":0, "type":"string", "description":"A unique identifier for the state or province.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unit of measure used for the material resource.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ExternallySourcedResource object, a unique ExternallySourcedResource object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                      • resourceId
                                                                                                                                                                                                                                      • resourceCode,resourceClass,workspaceId
                                                                                                                                                                                                                                      • resourceCode,resourceClass,workspaceCode
                                                                                                                                                                                                                                      • resourceCode,resourceClass,projectId
                                                                                                                                                                                                                                      • resourceCode,resourceClass,projectCode,workspaceCode
                                                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityExternallySourcedUser":{ "title":"ApiEntityExternallySourcedUser", "required":[ "email", "firstName", "lastName" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "lastAccessTime":{ "type":"string", "description":"The date and time the user last accessed OPC through any of the four channels.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lastDataServiceAPIAccessTime":{ "type":"string", "description":"The date and time the user last accessed OPC Data Service API.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lastLogInTime":{ "type":"string", "description":"Deprecated. As of 25.11, replaced by 'ApiEntityExternallySourcedUser.lastWebLogInTime'.
                                                                                                                                                                                                                                        The date and time the user last logged into the application.", "format":"date-time", "deprecated":true, "exampleSetFlag":false, "types":[ "string" ] }, "lastDeactivatedTime":{ "type":"string", "description":"The date and time the user was last deactivated in OPC.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lastRestAPIAccessTime":{ "type":"string", "description":"The date and time the user last accessed OPC REST API.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lastModeOfAccess":{ "type":"string", "description":"The last channel through which user accessed OPC.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WEB", "MOBILE", "REST API", "DATA SERVICE API" ] }, "userLocale":{ "type":"string", "description":"The language code for a user.
                                                                                                                                                                                                                                        1. pt_BR - Brazilian Portuguese
                                                                                                                                                                                                                                        2. nl - Dutch
                                                                                                                                                                                                                                        3. en - English
                                                                                                                                                                                                                                        4. fr - French
                                                                                                                                                                                                                                        5. de - German
                                                                                                                                                                                                                                        6. it - Italian
                                                                                                                                                                                                                                        7. ja - Japanese
                                                                                                                                                                                                                                        8. ko - Korean
                                                                                                                                                                                                                                        9. ru - Russian
                                                                                                                                                                                                                                        10. zh_CN - Simplified Chinese
                                                                                                                                                                                                                                        11. es - Spanish
                                                                                                                                                                                                                                        12. zh_TW - Traditional Chinese
                                                                                                                                                                                                                                        ", "exampleSetFlag":false, "types":[ "string" ] }, "lastName":{ "maxLength":100, "type":"string", "description":"The last name of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "userType":{ "type":"string", "description":"The type of the user.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "USER", "COMPANY_RESTRICTED", "APPLICATION_ADMIN", "IDEA_SUBMITTER" ] }, "firstName":{ "maxLength":100, "type":"string", "description":"The first name of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "lastMobileLogInTime":{ "type":"string", "description":"The date and time the user last logged into the application through Mobile.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "lastWebLogInTime":{ "type":"string", "description":"The date and time the user last logged into the application.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "title":{ "maxLength":25, "type":"string", "description":"The title of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "userId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "phone":{ "maxLength":100, "type":"string", "description":"The phone number of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "email":{ "maxLength":320, "type":"string", "description":"The email address of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "mobile":{ "maxLength":100, "type":"string", "description":"The mobile phone number of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "userSettings":{ "type":"array", "description":"A list of all user setting fields and values in the form of key value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "userProducts":{ "type":"array", "description":"A list of all user product fields and values in the form of key value pairs. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUserProduct", "exampleSetFlag":false }, "types":[ "array" ] }, "ldapGuid":{ "maxLength":255, "minLength":1, "type":"string", "description":"The unique identifier in the external authentication system (LDAP or IDCS).", "exampleSetFlag":false, "types":[ "string" ] }, "restrictedUser":{ "type":"boolean", "description":"Indicates that the user can only access records associated with the assigned company.", "exampleSetFlag":false, "types":[ "boolean" ] }, "userName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The identification used by a user to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] }, "companyId":{ "type":"integer", "description":"The company the user is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "maxLength":20, "type":"string", "description":"Determines the status of the user. When a user is inactive, they can no longer have access to login. Valid Values are ACTIVE and INACTIVE. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourceRoleAssignmentInput":{ "title":"ApiEntityResourceRoleAssignmentInput", "required":[ "resourceId", "roleId" ], "type":"object", "properties":{ "resourceRoleAssignmentId":{ "type":"integer", "description":"The system-generated identifier of the resource role assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "roleCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of the role.", "exampleSetFlag":false, "types":[ "string" ] }, "primaryFlag":{ "type":"boolean", "description":"Determines whether this is the resource's main role. A role that does not have this option selected indicates that this is a secondary role for the resource. You can only assign one primary role per resource. A resource is not required to have a primary role.", "exampleSetFlag":false, "types":[ "boolean" ] }, "proficiency":{ "type":"string", "description":"The skill level of the resource.
                                                                                                                                                                                                                                        Skill levels are Master, Expert, Skilled, Proficient, and Inexperienced.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ONE", "TWO", "THREE", "FOUR", "FIVE" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "roleId":{ "type":"integer", "description":"The unique identifier for the role.The role object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ResourceRoleAssignment object, a unique ResourceRoleAssignment object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                        • resourceRoleAssignmentId
                                                                                                                                                                                                                                        • resourceId,roleId
                                                                                                                                                                                                                                        • resourceCode,workspaceCode,roleId
                                                                                                                                                                                                                                        • resourceId,workspaceCode,roleCode
                                                                                                                                                                                                                                        • resourceCode,workspaceCode,roleCode
                                                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityResourceWorkRateCostInput":{ "title":"ApiEntityResourceWorkRateCostInput", "type":"object", "properties":{ "resourceWorkRateId":{ "type":"integer", "description":"The system-generated identifier of the work rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pricePerUnit1":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit2":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit3":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit4":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit5":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityResourceWorkRateInput":{ "title":"ApiEntityResourceWorkRateInput", "required":[ "effectiveStartDate", "maxUnitsPerTime", "resourceId", "workspaceId" ], "type":"object", "properties":{ "resourceWorkRateCost":{ "description":"An entity containing the price per unit fields of a resource work rate.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityResourceWorkRateCostInput" } ] }, "resourceWorkRateId":{ "type":"integer", "description":"The system-generated identifier of the work rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceResourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "effectiveStartDate":{ "type":"string", "description":"The date that the corresponding units/time period and rates go into effect for the resource or role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "maxUnitsPerTime":{ "type":"number", "description":"The maximum work units per time the resource or role can perform on all their assigned activities
                                                                                                                                                                                                                                          For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day. Similarly, if the selected resource is a department with 5 people, then the Max Units/Time may be 40.00h/d. This means that 5 people can perform 40 hours of work per day, rather than 1 person performing 8 hours of work per day.", "format":"double", "exampleSetFlag":false }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ResourceWorkRate object, a unique ResourceWorkRate object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                          • resourceWorkRateId
                                                                                                                                                                                                                                          • effectiveStartDate,workspaceResourceId
                                                                                                                                                                                                                                          • effectiveStartDate,resourceId,workspaceId
                                                                                                                                                                                                                                          • effectiveStartDate,resourceId,workspaceCode
                                                                                                                                                                                                                                          • effectiveStartDate,resourceCode,resourceClass,workspaceId
                                                                                                                                                                                                                                          • effectiveStartDate,resourceCode,resourceClass,workspaceCode
                                                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityUserProduct":{ "title":"ApiEntityUserProduct", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "userProductId":{ "type":"integer", "description":"The system-generated identifier for the user product.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "productId":{ "type":"integer", "description":"The system-generated unique identifier of a license.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "productName":{ "type":"string", "description":"The name of the license.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IDEA", "PORTFOLIO", "PROGRESS", "SCHEDULE", "TASKS" ] }, "applicationUserId":{ "type":"integer", "description":"The system-generated unique identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRelationship":{ "title":"ApiEntityRelationship", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "predActivity":{ "description":"The activity required to start or finish before an activity in the activity relationship starts or finishes, depending on the relationship type.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivity" } ] }, "succActivity":{ "description":"The activity required to start or finish after an activity in the activity relationship has started or finishes, depending on the relationship type.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivity" } ] }, "critical":{ "type":"boolean", "description":"Determines whether the activity is critical. An activity is critical when its total float is below the critical duration specified for the project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "relationshipId":{ "type":"integer", "description":"The system-generated identifier of an activity relationship.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "relationshipType":{ "type":"string", "description":"The relationship type defining the behavior between two activities. The valid values are Finish to Start, Finish to Finish, Start to Start, and Start to Finish.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "START_TO_START", "START_TO_FINISH", "FINISH_TO_START", "FINISH_TO_FINISH" ] }, "lagHours":{ "maximum":"99999999999", "minimum":"-99999999999", "type":"number", "description":"The amount of time the predecessor activity was delayed, affecting the ability of its successor activity to start or finish.", "format":"double", "exampleSetFlag":false }, "predActivityId":{ "type":"integer", "description":"The unique identifier of the predecessor of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "succActivityId":{ "type":"integer", "description":"The unique identifier of the successor of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "predActivityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the predecessor activity.", "exampleSetFlag":false, "types":[ "string" ] }, "succActivityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the successor activity.", "exampleSetFlag":false, "types":[ "string" ] }, "predProjectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of the project of the predecessor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "succProjectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of the project of the successor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "drivingRelationship":{ "type":"boolean", "description":"Determines whether the relationship is driving. A relationship is driving when the predecessor activity influences the start date of its successor.", "exampleSetFlag":false, "types":[ "boolean" ] }, "predProjectId":{ "type":"integer", "description":"Project ID containing the predecessor activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "succProjectId":{ "type":"integer", "description":"Project ID containing the successor activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "succWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the workspace of the successor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "predWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the workspace of the predecessor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRelationshipInput":{ "title":"ApiEntityRelationshipInput", "required":[ "predActivityId", "succActivityId" ], "type":"object", "properties":{ "predActivity":{ "description":"The activity required to start or finish before an activity in the activity relationship starts or finishes, depending on the relationship type.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityInput" } ] }, "succActivity":{ "description":"The activity required to start or finish after an activity in the activity relationship has started or finishes, depending on the relationship type.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityActivityInput" } ] }, "critical":{ "type":"boolean", "description":"Determines whether the activity is critical. An activity is critical when its total float is below the critical duration specified for the project.", "exampleSetFlag":false, "types":[ "boolean" ] }, "relationshipId":{ "type":"integer", "description":"The system-generated identifier of an activity relationship.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "relationshipType":{ "type":"string", "description":"The relationship type defining the behavior between two activities. The valid values are Finish to Start, Finish to Finish, Start to Start, and Start to Finish.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "START_TO_START", "START_TO_FINISH", "FINISH_TO_START", "FINISH_TO_FINISH" ] }, "lagHours":{ "maximum":"99999999999", "minimum":"-99999999999", "type":"number", "description":"The amount of time the predecessor activity was delayed, affecting the ability of its successor activity to start or finish.", "format":"double", "exampleSetFlag":false }, "predActivityId":{ "type":"integer", "description":"The unique identifier of the predecessor of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "succActivityId":{ "type":"integer", "description":"The unique identifier of the successor of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "predActivityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the predecessor activity.", "exampleSetFlag":false, "types":[ "string" ] }, "succActivityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the successor activity.", "exampleSetFlag":false, "types":[ "string" ] }, "predProjectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of the project of the predecessor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "succProjectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of the project of the successor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "drivingRelationship":{ "type":"boolean", "description":"Determines whether the relationship is driving. A relationship is driving when the predecessor activity influences the start date of its successor.", "exampleSetFlag":false, "types":[ "boolean" ] }, "predProjectId":{ "type":"integer", "description":"Project ID containing the predecessor activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "succProjectId":{ "type":"integer", "description":"Project ID containing the successor activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "succWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the workspace of the successor of an activity.", "exampleSetFlag":false, "types":[ "string" ] }, "predWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of the workspace of the predecessor of an activity.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a Relationship object, a unique Relationship object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                            • relationshipId
                                                                                                                                                                                                                                            • predActivityId,succActivityId
                                                                                                                                                                                                                                            • predActivityCode,predProjectCode,predWorkspaceCode,succActivityId
                                                                                                                                                                                                                                            • predActivityId,succActivityCode,succProjectCode,succWorkspaceCode
                                                                                                                                                                                                                                            • predActivityCode,predProjectCode,predWorkspaceCode,succActivityCode,succProjectCode,succWorkspaceCode
                                                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityReportUserPermissionsResponse":{ "title":"ApiEntityReportUserPermissionsResponse", "type":"object", "properties":{ "reportId":{ "type":"integer", "description":"The system-generated identifier of a report.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "profiles":{ "type":"array", "description":"Profiles response with individual message and statusCodes.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfileResponse", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityReportProfileInput":{ "title":"ApiEntityReportProfileInput", "type":"object", "properties":{ "reportProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the report profile.", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityReportUserPermissions":{ "title":"ApiEntityReportUserPermissions", "required":[ "reportCode" ], "type":"object", "properties":{ "reportId":{ "type":"integer", "description":"The system-generated identifier of a report.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReportProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "reportCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the report.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityReportCycle":{ "title":"ApiEntityReportCycle", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "prefix":{ "maxLength":255, "type":"string", "description":"The prefix for the period naming convention label, which is used to distinguish individual time periods when viewing reporting cycles in a time phased view.", "exampleSetFlag":false, "types":[ "string" ] }, "granularity":{ "type":"string", "description":"The level of granularity for the workspace report.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ] }, "periodId":{ "type":"integer", "description":"The unique identifier of a period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reportCycleId":{ "type":"integer", "description":"The unique identifier of a report cycle.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cycleName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the reporting cycle.", "exampleSetFlag":false, "types":[ "string" ] }, "suffixIncrement":{ "type":"integer", "description":"The number to increment the suffix by in each period naming convention label, which is used to distinguish individual time periods when viewing reporting cycles in a time phased view.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "baseDate":{ "type":"string", "description":"The date used as the starting point for generating the period start and end dates in a reporting cycle.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the workspace report.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the report cycle and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "suffix":{ "type":"integer", "description":"The numerical suffix for the period naming convention label, which is used to distinguish individual time periods when viewing reporting cycles in a time phased view.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityReportCycleInput":{ "title":"ApiEntityReportCycleInput", "required":[ "baseDate", "cycleName", "granularity", "suffix", "suffixIncrement", "workspaceId" ], "type":"object", "properties":{ "prefix":{ "maxLength":255, "type":"string", "description":"The prefix for the period naming convention label, which is used to distinguish individual time periods when viewing reporting cycles in a time phased view.", "exampleSetFlag":false, "types":[ "string" ] }, "granularity":{ "type":"string", "description":"The level of granularity for the workspace report.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ] }, "periodId":{ "type":"integer", "description":"The unique identifier of a period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reportCycleId":{ "type":"integer", "description":"The unique identifier of a report cycle.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cycleName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the reporting cycle.", "exampleSetFlag":false, "types":[ "string" ] }, "suffixIncrement":{ "type":"integer", "description":"The number to increment the suffix by in each period naming convention label, which is used to distinguish individual time periods when viewing reporting cycles in a time phased view.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "baseDate":{ "type":"string", "description":"The date used as the starting point for generating the period start and end dates in a reporting cycle.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the workspace report.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "suffix":{ "type":"integer", "description":"The numerical suffix for the period naming convention label, which is used to distinguish individual time periods when viewing reporting cycles in a time phased view.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ReportCycle object, a unique ReportCycle object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                              • reportCycleId
                                                                                                                                                                                                                                              • cycleName,workspaceId
                                                                                                                                                                                                                                              • cycleName,workspaceCode
                                                                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityResourceDemand":{ "title":"ApiEntityResourceDemand", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "duration":{ "type":"number", "description":"The total expected duration of the demand.", "format":"double", "exampleSetFlag":false }, "demandUnits":{ "type":"number", "description":"The sum of the demand units entered for a single role.", "format":"double", "exampleSetFlag":false }, "allocationPercentage":{ "type":"number", "description":"The allocation of the current role, displayed as a percentage of the availability of the role.", "format":"double", "exampleSetFlag":false }, "commitStartDate":{ "type":"string", "description":"The start date of the allocation commitment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "commitEndDate":{ "type":"string", "description":"The finish date of the allocation commitment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "commitDuration":{ "type":"number", "description":"The total duration of the commitments.", "format":"double", "exampleSetFlag":false }, "resourceDemandCost":{ "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityResourceDemandCost" } ] }, "resourceDemandId":{ "type":"integer", "description":"The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "commitFTE":{ "type":"number", "description":"The total committed FTE. Calculated as total commitment units divided by total commitment duration.", "exampleSetFlag":false, "types":[ "number" ] }, "committedUnits":{ "type":"number", "description":"The sum of committed units for a given project - role demand.", "format":"double", "exampleSetFlag":false }, "demandFTE":{ "type":"number", "description":"The total demand FTE. Calculated as total demand units divided by total demand duration.", "exampleSetFlag":false, "types":[ "number" ] }, "resourceDemandData":{ "type":"array", "description":"Data about demand for the resource.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceDemandData", "exampleSetFlag":false }, "types":[ "array" ] }, "requesterId":{ "type":"integer", "description":"The unique identifier of the user who submitted the demand.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "proposedFTE":{ "type":"number", "description":"The total proposed allocation FTE. Calculated as total proposed role allocation units divided by the total proposed role allocation duration.", "exampleSetFlag":false, "types":[ "number" ] }, "proposedAllocationUnits":{ "type":"number", "description":"The total role allocation units proposed.", "format":"double", "exampleSetFlag":false }, "periodId":{ "type":"integer", "description":"The unique identifier for the period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "proposedEndDate":{ "type":"string", "description":"The finish date of the proposed role allocations.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of appearance of demands in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The start date for the demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "proposedStartDate":{ "type":"string", "description":"The start date of the proposed role allocations.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedDuration":{ "type":"number", "description":"The total duration of the proposed role allocation units.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the current demand.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ] }, "endDate":{ "type":"string", "description":"The finish date for the demand.
                                                                                                                                                                                                                                                Calculated as Start plus Total Demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourceDemandCost":{ "title":"ApiEntityResourceDemandCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "demandCost":{ "type":"number", "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates. This field is in base currency and is calculated from demandCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "demandId":{ "type":"integer", "description":"The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "demandCostProject":{ "type":"number", "description":"The total cost associated with the role's demand in a project. This is calculated based on the standard role rates. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "committedCostProject":{ "type":"number", "description":"The total cost associated with the role's committed units in a project. This is calculated based on the standard role rates. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedCostProject":{ "type":"number", "description":"The total cost associated with the role's proposed allocation units in a project. This is calculated based on the standard role rates. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "resourceId":{ "type":"integer", "description":"The unique identifier of the assigned role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "committedCost":{ "type":"number", "description":"The total cost associated with the role's committed units. This is calculated based on the standard role rates. This field is in base currency and is calculated from committedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedCost":{ "type":"number", "description":"The total cost associated with the role's proposed allocation units. This is calculated based on the standard role rates. This field is in base currency and is calculated from proposedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourceDemandData":{ "title":"ApiEntityResourceDemandData", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "duration":{ "type":"number", "description":"The total expected duration of the weekly demand data.", "format":"double", "exampleSetFlag":false }, "resourceDemandDataCost":{ "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityResourceDemandDataCost" } ] }, "startOfMonth":{ "type":"string", "description":"The month in which the demand starts.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "committedFlag":{ "type":"boolean", "description":"Indicates whether the weekly demand data is committed.", "exampleSetFlag":false, "types":[ "boolean" ] }, "commitDate":{ "type":"string", "description":"The commitment date for the demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "demandUnits":{ "type":"number", "description":"The demand units entered for a single role.", "format":"double", "exampleSetFlag":false }, "resourceDemandId":{ "type":"integer", "description":"The unique identifier for the demand.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "demandDataId":{ "type":"integer", "description":"The unique identifier for the weekly demand data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "committedUnits":{ "type":"number", "description":"The total committed units of the weekly demand data.", "format":"double", "exampleSetFlag":false }, "allocatedUnits":{ "type":"number", "description":"The unit allocation for the current role.", "format":"double", "exampleSetFlag":false }, "proposedAllocationUnits":{ "type":"number", "description":"The total proposed duration of the demand.", "format":"double", "exampleSetFlag":false }, "startDate":{ "type":"string", "description":"The start date for the weekly demand data.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedDuration":{ "type":"number", "description":"The total role allocation units proposed.", "format":"double", "exampleSetFlag":false }, "status":{ "type":"string", "description":"The status of the current weekly demand data.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ] }, "endDate":{ "type":"string", "description":"The finish date for the weekly demand data.
                                                                                                                                                                                                                                                Calculated as Start plus Total Demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourceDemandDataCost":{ "title":"ApiEntityResourceDemandDataCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "demandCost":{ "type":"number", "description":"The total cost associated with the role's demand. This is calculated based on the standard role rates. This field is in base currency and is calculated from demandCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "demandDataId":{ "type":"integer", "description":"The unique identifier for the weekly demand data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "demandCostProject":{ "type":"number", "description":"The total cost associated with the role's demand in a project. This is calculated based on the standard role rates. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "committedCostProject":{ "type":"number", "description":"The total cost associated with the role's committed units in a project. This is calculated based on the standard role rates. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "proposedCostProject":{ "type":"number", "description":"The total cost associated with the role's proposed allocation units in a project. This is calculated based on the standard role rates. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "committedCost":{ "type":"number", "description":"The total cost associated with the role's committed units. This is calculated based on the standard role rates. This field is in base currency and is calculated from committedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "proposedCost":{ "type":"number", "description":"The total cost associated with the role's proposed allocation units. This is calculated based on the standard role rates.?? This field is in base currency and is calculated from proposedCostProject field based on the specified exchange rate. ", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourceDemandDataInput":{ "title":"ApiEntityResourceDemandDataInput", "required":[ "resourceDemandId" ], "type":"object", "properties":{ "duration":{ "type":"number", "description":"The total expected duration of the weekly demand data.", "format":"double", "exampleSetFlag":false }, "startOfMonth":{ "type":"string", "description":"The month in which the demand starts.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "committedFlag":{ "type":"boolean", "description":"Indicates whether the weekly demand data is committed.", "exampleSetFlag":false, "types":[ "boolean" ] }, "commitDate":{ "type":"string", "description":"The commitment date for the demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "demandUnits":{ "type":"number", "description":"The demand units entered for a single role.", "format":"double", "exampleSetFlag":false }, "resourceDemandId":{ "type":"integer", "description":"The unique identifier for the demand.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "demandDataId":{ "type":"integer", "description":"The unique identifier for the weekly demand data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "committedUnits":{ "type":"number", "description":"The total committed units of the weekly demand data.", "format":"double", "exampleSetFlag":false }, "allocatedUnits":{ "type":"number", "description":"The unit allocation for the current role.", "format":"double", "exampleSetFlag":false }, "proposedAllocationUnits":{ "type":"number", "description":"The total proposed duration of the demand.", "format":"double", "exampleSetFlag":false }, "startDate":{ "type":"string", "description":"The start date for the weekly demand data.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedDuration":{ "type":"number", "description":"The total role allocation units proposed.", "format":"double", "exampleSetFlag":false }, "status":{ "type":"string", "description":"The status of the current weekly demand data.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ] }, "endDate":{ "type":"string", "description":"The finish date for the weekly demand data.
                                                                                                                                                                                                                                                Calculated as Start plus Total Demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourceDemandInput":{ "title":"ApiEntityResourceDemandInput", "required":[ "projectId", "resourceId", "sequenceNumber" ], "type":"object", "properties":{ "duration":{ "type":"number", "description":"The total expected duration of the demand.", "format":"double", "exampleSetFlag":false }, "demandUnits":{ "type":"number", "description":"The sum of the demand units entered for a single role.", "format":"double", "exampleSetFlag":false }, "allocationPercentage":{ "type":"number", "description":"The allocation of the current role, displayed as a percentage of the availability of the role.", "format":"double", "exampleSetFlag":false }, "commitStartDate":{ "type":"string", "description":"The start date of the allocation commitment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "commitEndDate":{ "type":"string", "description":"The finish date of the allocation commitment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "commitDuration":{ "type":"number", "description":"The total duration of the commitments.", "format":"double", "exampleSetFlag":false }, "resourceDemandId":{ "type":"integer", "description":"The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "commitFTE":{ "type":"number", "description":"The total committed FTE. Calculated as total commitment units divided by total commitment duration.", "exampleSetFlag":false, "types":[ "number" ] }, "committedUnits":{ "type":"number", "description":"The sum of committed units for a given project - role demand.", "format":"double", "exampleSetFlag":false }, "demandFTE":{ "type":"number", "description":"The total demand FTE. Calculated as total demand units divided by total demand duration.", "exampleSetFlag":false, "types":[ "number" ] }, "resourceDemandData":{ "type":"array", "description":"Data about demand for the resource.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceDemandDataInput", "exampleSetFlag":false }, "types":[ "array" ] }, "requesterId":{ "type":"integer", "description":"The unique identifier of the user who submitted the demand.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "proposedFTE":{ "type":"number", "description":"The total proposed allocation FTE. Calculated as total proposed role allocation units divided by the total proposed role allocation duration.", "exampleSetFlag":false, "types":[ "number" ] }, "proposedAllocationUnits":{ "type":"number", "description":"The total role allocation units proposed.", "format":"double", "exampleSetFlag":false }, "periodId":{ "type":"integer", "description":"The unique identifier for the period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "proposedEndDate":{ "type":"string", "description":"The finish date of the proposed role allocations.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of appearance of demands in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The start date for the demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "proposedStartDate":{ "type":"string", "description":"The start date of the proposed role allocations.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedDuration":{ "type":"number", "description":"The total duration of the proposed role allocation units.", "format":"double", "exampleSetFlag":false }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the current demand.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ] }, "endDate":{ "type":"string", "description":"The finish date for the demand.
                                                                                                                                                                                                                                                Calculated as Start plus Total Demand.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ResourceDemand object, a unique ResourceDemand object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                • resourceDemandId
                                                                                                                                                                                                                                                • projectId,resourceId
                                                                                                                                                                                                                                                • resourceId,projectCode,workspaceCode
                                                                                                                                                                                                                                                • projectId,resourceCode,resourceClass,workspaceCode
                                                                                                                                                                                                                                                • projectCode,resourceCode,resourceClass,workspaceCode
                                                                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityResourcePlanProject":{ "title":"ApiEntityResourcePlanProject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "state":{ "type":"string", "description":"The state of capital plan project. Allowed Values:[ \"SELECTED\",\"UNSELECTED\",\"FORCED_IN\",\"FORCED_OUT\"]", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SELECTED", "UNSELECTED", "FORCED_IN", "FORCED_OUT" ] }, "totalProposedAllocationUnit":{ "type":"number", "description":"The total units proposed in project.", "format":"double", "exampleSetFlag":false }, "projectTotalAllocationDuration":{ "type":"number", "description":"The total duration of the allocation in project.", "format":"double", "exampleSetFlag":false }, "projectName":{ "type":"string", "description":"The name of a plan project associated with a scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "type":"string", "description":"The description of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "proposedEndDate":{ "type":"string", "description":"The end date for the proposed data in project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "undistributedAllocation":{ "type":"number", "description":"The total allocated units which are not distributed into any time buckets in project.", "format":"double", "exampleSetFlag":false }, "totalCommittedFTEUnit":{ "type":"number", "description":"The committed FTE in project.", "exampleSetFlag":false, "types":[ "number" ] }, "totalProposedFTEUnit":{ "type":"number", "description":"The proposed FTE in project.", "exampleSetFlag":false, "types":[ "number" ] }, "totalCommittedDuration":{ "type":"number", "description":"The total duration of the commitment in project.", "format":"double", "exampleSetFlag":false }, "totalProposedDuration":{ "type":"number", "description":"The total duration of the proposed data in project.", "format":"double", "exampleSetFlag":false }, "totalAllocatedCost":{ "type":"number", "description":"The total cost associated with the roles allocations made on project.", "format":"double", "exampleSetFlag":false }, "totalProposedCost":{ "type":"number", "description":"The total cost associated with the roles proposed units on project.", "format":"double", "exampleSetFlag":false }, "totalCommittedCost":{ "type":"number", "description":"The total cost associated with the roles committed units on project.", "format":"double", "exampleSetFlag":false }, "roleAllocations":{ "type":"array", "description":"The role data associated with plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourceRoleData", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The start date of a plan project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The finish date of a plan project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "totalAllocatedUnit":{ "type":"number", "description":"The total units allocated in project.", "format":"double", "exampleSetFlag":false }, "totalCommittedUnit":{ "type":"number", "description":"The total units committed in project.", "format":"double", "exampleSetFlag":false }, "totalAllocatedFTEUnit":{ "type":"number", "description":"The total allocated FTE in project.", "exampleSetFlag":false, "types":[ "number" ] }, "allocationStart":{ "type":"string", "description":"The start date for the allocation in project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "allocationFinish":{ "type":"string", "description":"The finish date for the allocation in project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "committedStartDate":{ "type":"string", "description":"The start date for the committed data in project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "committedFinishDate":{ "type":"string", "description":"The end date for the committed data in project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedStartDate":{ "type":"string", "description":"The start date for the proposed data in project.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periods":{ "type":"array", "description":"The period data associated with a plan project.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRoleDataPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourcePlanningScenario":{ "title":"ApiEntityResourcePlanningScenario", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectCount":{ "type":"integer", "description":"The total number of projects included in a resource plan scenario.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "hidden":{ "type":"boolean", "description":"The flag indicating whether the scenario is visible or hidden.", "exampleSetFlag":false, "types":[ "boolean" ] }, "owner":{ "type":"string", "description":"The owner of Resource Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "capitalPortfolioId":{ "type":"integer", "description":"Deprecated. As of 25.8.
                                                                                                                                                                                                                                                  The system-generated identifier of the Portfolio.", "format":"int64", "deprecated":true, "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioName":{ "type":"string", "description":"Deprecated. As of 25.8.
                                                                                                                                                                                                                                                  The name of the Portfolio.", "deprecated":true, "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of the Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "type":"string", "description":"The name of the Portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated identifier of the Resource Plan Scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "type":"string", "description":"The name of Resource Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioStatus":{ "type":"string", "description":"The status of Resource Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ] }, "planPeriod":{ "type":"integer", "description":"The period during which resources are allocated to projects within the plan. This value determines the year in which resource planning timescales start. You can set the planning period to either the current or following year. For example, if the year is 2025, the latest planning period you can set is 2026. After the planning period for a resource plan has been set it cannot be changed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioDescription":{ "type":"string", "description":"The description of a scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "createdBy":{ "type":"string", "description":"The scenario created username.", "exampleSetFlag":false, "types":[ "string" ] }, "lastRefreshDate":{ "type":"string", "description":"The date a refresh was last performed on the portfolio resource plan scenario.", "format":"date-time", "exampleSetFlag":false }, "committedCost":{ "type":"number", "description":"The total cost associated with the roles committed units on the scenario. This is calculated based on the standard role rates.", "format":"double", "exampleSetFlag":false }, "proposedCost":{ "type":"number", "description":"The total cost associated with the roles proposed units on the scenario. This is calculated based on the standard role rates.", "format":"double", "exampleSetFlag":false }, "allocatedCost":{ "type":"number", "description":"The total cost associated with the roles allocations made on the scenario. This is calculated based on the standard role rates.", "format":"double", "exampleSetFlag":false }, "resourcePlanId":{ "type":"integer", "description":"The system-generated identifier of the Resource Plan.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourcePlanStatus":{ "type":"string", "description":"The current resource status of a portfolio. In Planning: The portfolio is currently going through the resource planning process and contains one or more scenarios in planning. This status is set based on the status of scenarios and cannot be edited manually. In Planning is the default resource status. Revising: The portfolio currently has one scenario with a status of approved and another with a status of Under Review, Shared, or Under Approval. This status is set based on the status of scenarios and cannot be edited manually. Approved: The portfolio contains a scenario that has gone through the approval process and has been approved. This status is set based on the status of scenarios and cannot be edited manually.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IN_PLANNING", "CLOSED", "APPROVED", "REVISING" ] }, "totalAllocatedUnit":{ "type":"number", "description":"The total units allocated for a scenario.", "format":"double", "exampleSetFlag":false }, "totalCommittedUnit":{ "type":"number", "description":"The total units committed in scenario.", "format":"double", "exampleSetFlag":false }, "totalProposedUnit":{ "type":"number", "description":"The total cost associated with the roles committed units on the scenario. This is calculated based on the standard role rates.", "format":"double", "exampleSetFlag":false }, "totalAllocatedFTEUnit":{ "type":"number", "description":"The total allocated FTE for a scenario. Calculated as Total Allocation divided by Allocation Duration.", "exampleSetFlag":false, "types":[ "number" ] }, "totalCommittedFTEUnits":{ "type":"number", "description":"The committed FTE in a scenario.", "exampleSetFlag":false, "types":[ "number" ] }, "totalProposedFTEUnits":{ "type":"number", "description":"The proposed FTE in scenario.", "exampleSetFlag":false, "types":[ "number" ] }, "allocationStart":{ "type":"string", "description":"The start date for the allocation in scenario.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "allocationFinish":{ "type":"string", "description":"The end date for the allocation in scenario.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "committedStartDate":{ "type":"string", "description":"The start date for the committed data in scenario.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "committedFinishDate":{ "type":"string", "description":"The end date for the committed data in scenario.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedStartDate":{ "type":"string", "description":"The start date for the proposed data in scenario.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedFinishDate":{ "type":"string", "description":"TThe start date for the proposed data in scenario.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "allocationDuration":{ "type":"number", "description":"The total duration of the allocation in scenario.", "format":"double", "exampleSetFlag":false }, "proposedDuration":{ "type":"number", "description":"The total duration of the proposed data in scenario.", "format":"double", "exampleSetFlag":false }, "committedDuration":{ "type":"number", "description":"The total duration of the commitment in scenario.", "format":"double", "exampleSetFlag":false }, "projects":{ "type":"array", "description":"The plan projects associated with a scenario.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityResourcePlanProject", "exampleSetFlag":false }, "types":[ "array" ] }, "createDate":{ "type":"string", "description":"The created date of the Resource Plan Scenario .", "format":"date-time", "exampleSetFlag":false }, "periods":{ "type":"array", "description":"The period data associated with resource plan scenario.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRoleDataPeriod", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityResourceRoleData":{ "title":"ApiEntityResourceRoleData", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "id":{ "type":"integer", "description":"The unique identifier of a role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceName":{ "type":"string", "description":"The name of role.", "exampleSetFlag":false, "types":[ "string" ] }, "allocattedDuration":{ "type":"number", "description":"Duration of the allocation for role.", "format":"double", "exampleSetFlag":false }, "proposedAllocationUnits":{ "type":"number", "description":"The total units proposed for role.", "format":"double", "exampleSetFlag":false }, "proposedUnitFTE":{ "type":"number", "description":"The proposed FTE for role.", "exampleSetFlag":false, "types":[ "number" ] }, "proposedEndDate":{ "type":"string", "description":"The end date for the proposed data for role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "undistributedAllocation":{ "type":"number", "description":"The total allocated units which are not distributed into any time buckets for role.", "format":"double", "exampleSetFlag":false }, "totalCommittedFTEUnit":{ "type":"number", "description":"The committed FTE for role.", "exampleSetFlag":false, "types":[ "number" ] }, "totalCommittedDuration":{ "type":"number", "description":"The total duration of the commitment for role.", "format":"double", "exampleSetFlag":false }, "resourceCode":{ "type":"string", "description":"The user-specified identifier of a role.", "exampleSetFlag":false, "types":[ "string" ] }, "allocatedCost":{ "type":"number", "description":"The total cost associated with a role.", "format":"double", "exampleSetFlag":false }, "totalAllocatedUnit":{ "type":"number", "description":"The total units allocated for role.", "format":"double", "exampleSetFlag":false }, "totalCommittedUnit":{ "type":"number", "description":"The total units committed for role.", "format":"double", "exampleSetFlag":false }, "totalAllocatedFTEUnit":{ "type":"number", "description":"The total allocated FTE for role.", "exampleSetFlag":false, "types":[ "number" ] }, "allocationStart":{ "type":"string", "description":"The start date for the allocation for role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "allocationFinish":{ "type":"string", "description":"The end date for the allocation for role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "committedStartDate":{ "type":"string", "description":"The start date for the committed data for role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "committedFinishDate":{ "type":"string", "description":"The end date for the committed data for role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedStartDate":{ "type":"string", "description":"The start date for the proposed data for role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "proposedDuration":{ "type":"number", "description":"Duration of the proposed data for role.", "format":"double", "exampleSetFlag":false }, "periods":{ "type":"array", "description":"The period data associated with role.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRoleDataPeriod", "exampleSetFlag":false }, "types":[ "array" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRoleDataPeriod":{ "title":"ApiEntityRoleDataPeriod", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "start":{ "type":"string", "description":"Start date of a individual period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "roleDataPerDataPeriodCost":{ "description":"Associated costs for a period of a role.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRoleDataPeriodCost" } ] }, "allocatedDataUnits":{ "type":"number", "description":"Allocated units for a period of a role.", "format":"double", "exampleSetFlag":false }, "proposedDataUnits":{ "type":"number", "description":"Proposed units for a period of a role.", "format":"double", "exampleSetFlag":false }, "committedDataUnits":{ "type":"number", "description":"Committed units for a period of a role.", "format":"double", "exampleSetFlag":false }, "allocatedDataUnitsFTE":{ "type":"number", "description":"Allocated FTE for a period of a role.", "exampleSetFlag":false, "types":[ "number" ] }, "proposedDataUnitsFTE":{ "type":"number", "description":"Proposed FTE for a period of a role", "exampleSetFlag":false, "types":[ "number" ] }, "committedDataUnitsFTE":{ "type":"number", "description":"Committed FTE for a period of a role.", "exampleSetFlag":false, "types":[ "number" ] }, "end":{ "type":"string", "description":"End date of a individual period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRoleDataPeriodCost":{ "title":"ApiEntityRoleDataPeriodCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "committedCost":{ "type":"number", "description":"Committed cost for a period for a role.", "format":"double", "exampleSetFlag":false }, "proposedCost":{ "type":"number", "description":"Proposed cost for a period for a role.", "format":"double", "exampleSetFlag":false }, "allocatedCost":{ "type":"number", "description":"Allocated cost for a period for a role.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourcePlanningScenarioInput":{ "title":"ApiEntityResourcePlanningScenarioInput", "required":[ "planPeriod", "portfolioId", "scenarioName" ], "type":"object", "properties":{ "hidden":{ "type":"boolean", "description":"The flag indicating whether the scenario is visible or hidden.", "exampleSetFlag":false, "types":[ "boolean" ] }, "capitalPortfolioId":{ "type":"integer", "description":"Deprecated. As of 25.8.
                                                                                                                                                                                                                                                  The system-generated identifier of the Portfolio.", "format":"int64", "deprecated":true, "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioName":{ "type":"string", "description":"Deprecated. As of 25.8.
                                                                                                                                                                                                                                                  The name of the Portfolio.", "deprecated":true, "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of the Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "type":"string", "description":"The name of the Portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated identifier of the Resource Plan Scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "type":"string", "description":"The name of Resource Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "planPeriod":{ "type":"integer", "description":"The period during which resources are allocated to projects within the plan. This value determines the year in which resource planning timescales start. You can set the planning period to either the current or following year. For example, if the year is 2025, the latest planning period you can set is 2026. After the planning period for a resource plan has been set it cannot be changed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioDescription":{ "type":"string", "description":"The description of a scenario.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourcePlanningScenarioStatusInput":{ "title":"ApiEntityResourcePlanningScenarioStatusInput", "type":"object", "properties":{ "capitalPortfolioId":{ "type":"integer", "description":"Deprecated. As of 25.8.
                                                                                                                                                                                                                                                  The system-generated identifier of the Portfolio.", "format":"int64", "deprecated":true, "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioName":{ "type":"string", "description":"Deprecated. As of 25.8.
                                                                                                                                                                                                                                                  The name of the Portfolio.", "deprecated":true, "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The system-generated identifier of the Portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "type":"string", "description":"The name of the Portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated identifier of the Resource Plan Scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "type":"string", "description":"The name of Resource Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioStatus":{ "type":"string", "description":"The status of Resource Plan Scenario.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "APPROVED", "UNDER_REVIEW", "IN_PLANNING", "UNDER_APPROVAL", "RETIRED", "SHARED", "PENDING_APPROVAL", "PENDING_SHARED", "PENDING_IN_PLANNING" ] }, "planPeriod":{ "type":"integer", "description":"The period during which resources are allocated to projects within the plan. This value determines the year in which resource planning timescales start. You can set the planning period to either the current or following year. For example, if the year is 2025, the latest planning period you can set is 2026. After the planning period for a resource plan has been set it cannot be changed.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ResourcePlanningScenarioStatus object, a unique ResourcePlanningScenarioStatus object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                  • scenarioId
                                                                                                                                                                                                                                                  • scenarioName,planPeriod,portfolioId
                                                                                                                                                                                                                                                  • scenarioName,planPeriod,portfolioName,workspaceCode
                                                                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityResourceRoleAssignment":{ "title":"ApiEntityResourceRoleAssignment", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "resourceRoleAssignmentId":{ "type":"integer", "description":"The system-generated identifier of the resource role assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "roleCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of the role.", "exampleSetFlag":false, "types":[ "string" ] }, "primaryFlag":{ "type":"boolean", "description":"Determines whether this is the resource's main role. A role that does not have this option selected indicates that this is a secondary role for the resource. You can only assign one primary role per resource. A resource is not required to have a primary role.", "exampleSetFlag":false, "types":[ "boolean" ] }, "proficiency":{ "type":"string", "description":"The skill level of the resource.
                                                                                                                                                                                                                                                    Skill levels are Master, Expert, Skilled, Proficient, and Inexperienced.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ONE", "TWO", "THREE", "FOUR", "FIVE" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "roleId":{ "type":"integer", "description":"The unique identifier for the role.The role object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourceWorkRate":{ "title":"ApiEntityResourceWorkRate", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "resourceWorkRateCost":{ "description":"An entity containing the price per unit fields of a resource work rate.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityResourceWorkRateCost" } ] }, "resourceWorkRateId":{ "type":"integer", "description":"The system-generated identifier of the work rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceResourceId":{ "type":"integer", "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "effectiveStartDate":{ "type":"string", "description":"The date that the corresponding units/time period and rates go into effect for the resource or role.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "maxUnitsPerTime":{ "type":"number", "description":"The maximum work units per time the resource or role can perform on all their assigned activities
                                                                                                                                                                                                                                                    For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day. Similarly, if the selected resource is a department with 5 people, then the Max Units/Time may be 40.00h/d. This means that 5 people can perform 40 hours of work per day, rather than 1 person performing 8 hours of work per day.", "format":"double", "exampleSetFlag":false }, "resourceClass":{ "type":"string", "description":"The class identifies the item as a resource or a role.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE" ] }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityResourceWorkRateCost":{ "title":"ApiEntityResourceWorkRateCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "resourceWorkRateId":{ "type":"integer", "description":"The system-generated identifier of the work rate.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pricePerUnit1":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit2":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit3":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit4":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "pricePerUnit5":{ "minimum":0, "type":"number", "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMatrix":{ "title":"ApiEntityRiskMatrix", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scoreTypes":{ "type":"array", "description":"List of risk types associated with the risk matrix.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrixScoreType", "exampleSetFlag":false }, "types":[ "array" ] }, "tolerances":{ "type":"array", "description":"List of risk tolerances associated with the risk matrix.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrixTolerance", "exampleSetFlag":false }, "types":[ "array" ] }, "matrixDescription":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary of the risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreMatrixMethod":{ "type":"string", "description":"The type of calculation used to obtain an overall impact value. The valid values are Highest Impact and Average Impact.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HIGHEST", "AVERAGE_IMPACTS", "AVERAGE_INDIVIDUAL_SCORES" ] }, "impactLevels":{ "type":"integer", "description":"The degree to which a risk matrix is impacted.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "probabilityLevels":{ "type":"integer", "description":"A count of the number of levels (thresholds) for the probability score type associated with the matrix. This does not count the Negligible level.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "referencedRiskMatrixId":{ "type":"integer", "description":"Unique identifier of a risk matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMatrixId":{ "type":"integer", "description":"The system-generated identifier of the risk matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "matrixName":{ "maxLength":60, "minLength":1, "type":"string", "description":"The name of the risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The workspace that contains the risk matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the risk matrix.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the risk matrix and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scores":{ "type":"array", "description":"List of risk scores associated with the risk matrix.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrixScore", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMatrixScore":{ "title":"ApiEntityRiskMatrixScore", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "probabilityThresholdLevel":{ "maximum":9, "minimum":1, "type":"integer", "description":"The level at which threshold probability is measured.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMatrixScoreId":{ "type":"integer", "description":"The unique identifier of a risk matrix score.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "severityOne":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityTwo":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityThree":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityFour":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityFive":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severitySix":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severitySeven":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityEight":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityNine":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityOneLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityTwoLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityThreeLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityFourLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityFiveLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severitySixLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severitySevenLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityEightLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityNineLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMatrixId":{ "type":"integer", "description":"The unique identifier of a risk scoring matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "matrixName":{ "maxLength":60, "type":"string", "description":"The name of the risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete the particular nested entry in the list of scores. A valid riskMatrixScoreId or probabilityThresholdLevel value must be provided to perform deletion.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMatrixScoreType":{ "title":"ApiEntityRiskMatrixScoreType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreType":{ "description":"A risk score type.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRiskScoreType" } ] }, "riskMatrixScoreTypeId":{ "type":"integer", "description":"The unique identifier of a risk matrix score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk score type.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The unique identifier for the risk matrix score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMatrixId":{ "type":"integer", "description":"The unique identifier for the risk scoring matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "matrixName":{ "maxLength":60, "minLength":1, "type":"string", "description":"The name of the risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete the particular nested entry in the list of scoreTypes. A valid riskMatrixScoreTypeId, riskScoreTypeId, or riskScoreTypeName value must be provided to perform deletion.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMatrixTolerance":{ "title":"ApiEntityRiskMatrixTolerance", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "value":{ "type":"number", "description":"A risk matrix tolerance value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "color":{ "maxLength":6, "minLength":1, "type":"string", "description":"Color that represents the urgency of the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMatrixId":{ "type":"integer", "description":"The unique identifier for the risk matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMatrixToleranceId":{ "type":"integer", "description":"The unique identifier of a matrix tolerance.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMatrixName":{ "maxLength":60, "minLength":1, "type":"string", "description":"The name of the risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the particular nested entry in the list of tolerances. A valid riskMatrixToleranceId or value must be provided to perform deletion.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskScoreThreshold":{ "title":"ApiEntityRiskScoreThreshold", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "level":{ "maximum":10, "minimum":0, "type":"integer", "description":"The level of the risk threshold.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "color":{ "maxLength":6, "minLength":6, "type":"string", "description":"The color that represents the urgency of the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "lower":{ "type":"number", "description":"The lower limit of the risk score threshold range.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "upper":{ "type":"number", "description":"The upper limit of the risk score threshold range.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "riskScoreThresholdName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk threshold.", "exampleSetFlag":false, "types":[ "string" ] }, "stringValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"The value of the string.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreThresholdId":{ "type":"integer", "description":"The unique ID of the risk score threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk scoring threshold.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk score type.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The category to which the risk score belongs.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete the particular nested entry in the list of risk score thresholds. A valid riskScoreThresholdId, riskScoreThresholdCode, or level value must be provided to perform deletion.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRiskScoreType":{ "title":"ApiEntityRiskScoreType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreThresholds":{ "type":"array", "description":"An array of the risk threshold values for a selected risk threshold.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreThreshold", "exampleSetFlag":false }, "types":[ "array" ] }, "referencedScoreTypeId":{ "type":"integer", "description":"The unique identifier of a copied score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scoreType":{ "type":"string", "description":"The type of risk score.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ] }, "riskScoreTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk score type.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The unique identifier of a score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of a workspace associated to a risk score.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the risk score.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the risk score type and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMatrixInput":{ "title":"ApiEntityRiskMatrixInput", "required":[ "matrixName", "scoreTypes", "workspaceId" ], "type":"object", "properties":{ "scoreTypes":{ "type":"array", "description":"List of risk types associated with the risk matrix.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrixScoreTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "tolerances":{ "type":"array", "description":"List of risk tolerances associated with the risk matrix.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrixToleranceInput", "exampleSetFlag":false }, "types":[ "array" ] }, "matrixDescription":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary of the risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreMatrixMethod":{ "type":"string", "description":"The type of calculation used to obtain an overall impact value. The valid values are Highest Impact and Average Impact.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HIGHEST", "AVERAGE_IMPACTS", "AVERAGE_INDIVIDUAL_SCORES" ] }, "riskMatrixId":{ "type":"integer", "description":"The system-generated identifier of the risk matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "matrixName":{ "maxLength":60, "minLength":1, "type":"string", "description":"The name of the risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The workspace that contains the risk matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the risk matrix.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scores":{ "type":"array", "description":"List of risk scores associated with the risk matrix.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskMatrixScoreInput", "exampleSetFlag":false }, "types":[ "array" ] } }, "description":"This entity represents a RiskMatrix object, a unique RiskMatrix object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                    • riskMatrixId
                                                                                                                                                                                                                                                    • matrixName,projectId
                                                                                                                                                                                                                                                    • matrixName,projectCode,workspaceCode
                                                                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityRiskMatrixScoreInput":{ "title":"ApiEntityRiskMatrixScoreInput", "required":[ "probabilityThresholdLevel", "riskMatrixId" ], "type":"object", "properties":{ "probabilityThresholdLevel":{ "maximum":9, "minimum":1, "type":"integer", "description":"The level at which threshold probability is measured.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMatrixScoreId":{ "type":"integer", "description":"The unique identifier of a risk matrix score.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "severityOne":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityTwo":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityThree":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityFour":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityFive":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severitySix":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severitySeven":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityEight":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityNine":{ "maximum":1000000000, "minimum":-1000000000, "type":"integer", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "severityOneLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityTwoLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityThreeLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityFourLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityFiveLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severitySixLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severitySevenLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityEightLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "severityNineLabel":{ "maxLength":40, "minLength":0, "type":"string", "description":"The severity level of schedule and cost impacts in your risk scoring matrix.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMatrixId":{ "type":"integer", "description":"The unique identifier of a risk scoring matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete the particular nested entry in the list of scores. A valid riskMatrixScoreId or probabilityThresholdLevel value must be provided to perform deletion.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMatrixScoreTypeInput":{ "title":"ApiEntityRiskMatrixScoreTypeInput", "required":[ "riskMatrixId", "riskScoreTypeId" ], "type":"object", "properties":{ "riskMatrixScoreTypeId":{ "type":"integer", "description":"The unique identifier of a risk matrix score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk score type.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The unique identifier for the risk matrix score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMatrixId":{ "type":"integer", "description":"The unique identifier for the risk scoring matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete the particular nested entry in the list of scoreTypes. A valid riskMatrixScoreTypeId, riskScoreTypeId, or riskScoreTypeName value must be provided to perform deletion.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMatrixToleranceInput":{ "title":"ApiEntityRiskMatrixToleranceInput", "required":[ "color", "riskMatrixId", "value" ], "type":"object", "properties":{ "value":{ "type":"number", "description":"A risk matrix tolerance value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "color":{ "maxLength":6, "minLength":1, "type":"string", "description":"Color that represents the urgency of the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMatrixId":{ "type":"integer", "description":"The unique identifier for the risk matrix.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMatrixToleranceId":{ "type":"integer", "description":"The unique identifier of a matrix tolerance.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the particular nested entry in the list of tolerances. A valid riskMatrixToleranceId or value must be provided to perform deletion.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityRiskMitigationFinancialInput":{ "title":"ApiEntityRiskMitigationFinancialInput", "type":"object", "properties":{ "riskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualCost":{ "type":"number", "description":"The response action Actual Cost.", "format":"double", "exampleSetFlag":false }, "remainingTotalCost":{ "type":"number", "description":"The response action Remaining Cost.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityRiskMitigationInput":{ "title":"ApiEntityRiskMitigationInput", "required":[ "projectRiskId", "riskMitigationName" ], "type":"object", "properties":{ "riskMitigationFinancial":{ "description":"The financial fields associated with a risk mitigation.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRiskMitigationFinancialInput" } ] }, "riskMitigationId":{ "type":"integer", "description":"The system-generated identifier of a risk mitigation.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskMitigationCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "riskMitigationName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk response action item.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The system-generated identifier of the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of the project risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"The detailed summary of the risk mitigation.", "exampleSetFlag":false }, "mitigationStatus":{ "type":"string", "description":"The status of the risk response action item.
                                                                                                                                                                                                                                                      Proposed: The response action has been proposed.
                                                                                                                                                                                                                                                      Sanctioned: The response action has been sanctioned.
                                                                                                                                                                                                                                                      Not Started: The response action has not started.
                                                                                                                                                                                                                                                      In Progress: The response action has started but has not been completed.
                                                                                                                                                                                                                                                      Completed: The response action has been completed.
                                                                                                                                                                                                                                                      Rejected: The response action has been rejected.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROPOSED", "SANCTIONED", "NOT_STARTED", "REJECTED", "IN_PROGRESS", "COMPLETED" ] }, "plannedFinishDate":{ "type":"string", "description":"The latest scheduled finish date of all the risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedStartDate":{ "type":"string", "description":"The earliest scheduled start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The earliest start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "finishDate":{ "type":"string", "description":"The latest finish date of all risk response action items. If the activity ID is null, then this field is READ ONLY.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "ownerId":{ "type":"integer", "description":"The name of the resource responsible for the risk response action item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a RiskMitigation object, a unique RiskMitigation object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                      • riskMitigationId
                                                                                                                                                                                                                                                      • riskMitigationCode,projectRiskId
                                                                                                                                                                                                                                                      • riskMitigationCode,riskCode,projectId
                                                                                                                                                                                                                                                      • riskMitigationCode,riskCode,projectCode,workspaceCode
                                                                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityRiskScoreThresholdInput":{ "title":"ApiEntityRiskScoreThresholdInput", "required":[ "color", "level", "lower", "riskScoreThresholdCode", "riskScoreThresholdName", "riskScoreTypeId", "upper" ], "type":"object", "properties":{ "level":{ "maximum":10, "minimum":0, "type":"integer", "description":"The level of the risk threshold.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "color":{ "maxLength":6, "minLength":6, "type":"string", "description":"The color that represents the urgency of the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "lower":{ "type":"number", "description":"The lower limit of the risk score threshold range.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "upper":{ "type":"number", "description":"The upper limit of the risk score threshold range.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "riskScoreThresholdName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk threshold.", "exampleSetFlag":false, "types":[ "string" ] }, "stringValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"The value of the string.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreThresholdId":{ "type":"integer", "description":"The unique ID of the risk score threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "riskScoreThresholdCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The unique identifier for the risk scoring threshold.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The category to which the risk score belongs.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete the particular nested entry in the list of risk score thresholds. A valid riskScoreThresholdId, riskScoreThresholdCode, or level value must be provided to perform deletion.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityRiskScoreTypeInput":{ "title":"ApiEntityRiskScoreTypeInput", "required":[ "riskScoreTypeName", "scoreType", "workspaceId" ], "type":"object", "properties":{ "riskScoreThresholds":{ "type":"array", "description":"An array of the risk threshold values for a selected risk threshold.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRiskScoreThresholdInput", "exampleSetFlag":false }, "types":[ "array" ] }, "scoreType":{ "type":"string", "description":"The type of risk score.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ] }, "riskScoreTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the risk score type.", "exampleSetFlag":false, "types":[ "string" ] }, "riskScoreTypeId":{ "type":"integer", "description":"The unique identifier of a score type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of a workspace associated to a risk score.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the risk score.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The unique identifier for the program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a RiskScoreType object, a unique RiskScoreType object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                        • riskScoreTypeId
                                                                                                                                                                                                                                                        • riskScoreTypeName,projectId
                                                                                                                                                                                                                                                        • riskScoreTypeName,projectCode,workspaceCode
                                                                                                                                                                                                                                                        • riskScoreTypeName,workspaceId
                                                                                                                                                                                                                                                        • riskScoreTypeName,workspaceCode
                                                                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityRiskWeatherPeriodInput":{ "title":"ApiEntityRiskWeatherPeriodInput", "required":[ "nonWorkingTimeDefinitionType", "periodFinish", "periodName", "periodStart", "projectRiskId" ], "type":"object", "properties":{ "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "riskWeatherPeriodId":{ "type":"integer", "description":"The system-generated identifier for the period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectRiskId":{ "type":"integer", "description":"The system-generated identifier of a Risk.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the period.", "exampleSetFlag":false, "types":[ "string" ] }, "riskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the risk.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "shape":{ "type":"string", "description":"The probability distribution that best models the estimates for non-working days in the period. Valid values are Triangle and Uniform. If the value is Uniform, the required fields are minimum and maximum non-working days. If the value is Triangle, the required fields are minimum, maximum, and most-likely non-working days.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TRIANGLE", "UNIFORM", "BETAPERT" ] }, "mostLikelyNonWorkingDays":{ "type":"integer", "description":"The most likely number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "nonWorkingDaysPercentage":{ "type":"number", "description":"The percentage of non-working days in the period.", "format":"double", "exampleSetFlag":false }, "nonWorkingTimeDefinitionType":{ "type":"string", "description":"The method used to define the weather risk's non-working time. Valid values are Percentage and Distribution. If the value is Percentage, the required fields are non-working persistence and non-working days percentage. If the value is Distribution, the required fields are shape, minimum non-working days, most-likely non-working days, and maximum non-working days.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PERCENTAGE", "DISTRIBUTION" ] }, "periodStart":{ "type":"string", "description":"The start date of the period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "periodFinish":{ "type":"string", "description":"The finish date of the period.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "minNonWorkingDays":{ "type":"integer", "description":"The minimum number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "maxNonWorkingDays":{ "type":"integer", "description":"The maximum number of non-working days in the period.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "nonWorkingPersistence":{ "type":"number", "description":"The probability of a non-working day following another non-working day in the period.", "format":"double", "exampleSetFlag":false } }, "description":"This entity represents a RiskWeatherPeriod object, a unique RiskWeatherPeriod object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                          • riskWeatherPeriodId
                                                                                                                                                                                                                                                          • periodName,projectRiskId
                                                                                                                                                                                                                                                          • periodName,riskCode,projectId
                                                                                                                                                                                                                                                          • periodName,riskCode,projectCode,workspaceCode
                                                                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityRuleOfCredit":{ "title":"ApiEntityRuleOfCredit", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"Determines how each milestone in a rule of credit can be progressed.
                                                                                                                                                                                                                                                            Manual: Allows partial completion of a milestone, entered as a percentage.
                                                                                                                                                                                                                                                            0/100%: Partial progress cannot be made when progressing a milestone. As soon as the milestone is selected, the milestone is 100% complete.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "ZERO_TO_ONE_HUNDRED" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the rule of credit.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the rule of credit and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "milestones":{ "type":"array", "description":"The milestones associated with the rule of credit.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestone", "exampleSetFlag":false }, "types":[ "array" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "rocName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the rule of credit.", "exampleSetFlag":false, "types":[ "string" ] }, "rocId":{ "type":"integer", "description":"Unique identifier of the rule of credit.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRuleOfCreditMilestone":{ "title":"ApiEntityRuleOfCreditMilestone", "required":[ "milestoneName", "percentComplete", "sequenceNumber" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "milestoneName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the milestone for the rule of credit.", "exampleSetFlag":false, "types":[ "string" ] }, "milestoneId":{ "type":"integer", "description":"Unique identifier of the rule of credit milestone.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The percentage of work to be completed for the milestone in relation to the entire rule of credit.", "format":"double", "exampleSetFlag":false }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of a milestone in a milestone list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ruleOfCreditId":{ "type":"integer", "description":"The unique identifier of a rule of credit.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRuleOfCreditInput":{ "title":"ApiEntityRuleOfCreditInput", "required":[ "milestones", "rocName", "workspaceId" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"Determines how each milestone in a rule of credit can be progressed.
                                                                                                                                                                                                                                                            Manual: Allows partial completion of a milestone, entered as a percentage.
                                                                                                                                                                                                                                                            0/100%: Partial progress cannot be made when progressing a milestone. As soon as the milestone is selected, the milestone is 100% complete.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "ZERO_TO_ONE_HUNDRED" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the rule of credit.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "milestones":{ "type":"array", "description":"The milestones associated with the rule of credit.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestoneInput", "exampleSetFlag":false }, "types":[ "array" ] }, "rocName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the rule of credit.", "exampleSetFlag":false, "types":[ "string" ] }, "rocId":{ "type":"integer", "description":"Unique identifier of the rule of credit.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a RuleOfCredit object, a unique RuleOfCredit object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                            • rocId
                                                                                                                                                                                                                                                            • rocName,workspaceId
                                                                                                                                                                                                                                                            • rocName,workspaceCode
                                                                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityRuleOfCreditMilestoneInput":{ "title":"ApiEntityRuleOfCreditMilestoneInput", "required":[ "milestoneName", "percentComplete", "sequenceNumber" ], "type":"object", "properties":{ "milestoneName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the milestone for the rule of credit.", "exampleSetFlag":false, "types":[ "string" ] }, "milestoneId":{ "type":"integer", "description":"Unique identifier of the rule of credit milestone.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The percentage of work to be completed for the milestone in relation to the entire rule of credit.", "format":"double", "exampleSetFlag":false }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of a milestone in a milestone list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "ruleOfCreditId":{ "type":"integer", "description":"The unique identifier of a rule of credit.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityScheduleScenario":{ "title":"ApiEntityScheduleScenario", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"The type of the scenario. A scenario can have a type of What-if, Closed, or Retired.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WHAT_IF", "RETIRED", "CLOSED" ] }, "hidden":{ "type":"boolean", "description":"Indicates if a scenario is hidden on the Activities page.", "exampleSetFlag":false, "types":[ "boolean" ] }, "name":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "time":{ "type":"string", "description":"The time at which the scenario was generated. Allowed format is \"yyyy-MM-dd'T'HH:mm:ss.Z\".", "format":"date-time", "exampleSetFlag":false }, "sourceDescription":{ "type":"string", "description":"The source of the schedule scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated unique identifier of the schedule scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the scenario. A scenario can have a status of In Progress, Failed, or Complete.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IN_PROGRESS", "FAILED", "COMPLETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScheduleScenarioInput":{ "title":"ApiEntityScheduleScenarioInput", "required":[ "name", "projectId" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"The type of the scenario. A scenario can have a type of What-if, Closed, or Retired.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WHAT_IF", "RETIRED", "CLOSED" ] }, "hidden":{ "type":"boolean", "description":"Indicates if a scenario is hidden on the Activities page.", "exampleSetFlag":false, "types":[ "boolean" ] }, "name":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "time":{ "type":"string", "description":"The time at which the scenario was generated. Allowed format is \"yyyy-MM-dd'T'HH:mm:ss.Z\".", "format":"date-time", "exampleSetFlag":false }, "sourceType":{ "type":"string", "description":"The source type of the schedule scenario. Default Value is CURRENT_SCHEDULE.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "BASELINE", "SCENARIO", "CURRENT_SCHEDULE", "FROM_HISTORY" ] }, "sourceName":{ "type":"string", "description":"Name of baseline or scenario.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A detailed summary for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the project's workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "scenarioId":{ "type":"integer", "description":"The system-generated unique identifier of the schedule scenario.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ScheduleScenario object, a unique ScheduleScenario object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                              • scenarioId
                                                                                                                                                                                                                                                              • name,projectId
                                                                                                                                                                                                                                                              • name,projectCode,workspaceCode
                                                                                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityScopeAssignmentActualsTimePhasedCostData":{ "title":"ApiEntityScopeAssignmentActualsTimePhasedCostData", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentActualsTimePhasedDataId":{ "type":"integer", "description":"Actuals time phased data ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualsCost":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This field is in base currency and is calculated from actualsCostProject field based on the specified exchange rate.
                                                                                                                                                                                                                                                                This is a manual entry field.", "format":"double", "exampleSetFlag":false }, "actualsCostProject":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentActualsTimePhasedData":{ "title":"ApiEntityScopeAssignmentActualsTimePhasedData", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"The date on which work on a work package began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentActualsTimePhasedCostData":{ "description":"An object containing the cost fields associated with the actuals time phased data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedCostData" } ] }, "scopeAssignmentActualsTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope actuals time phased data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualsHours":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
                                                                                                                                                                                                                                                                This is a manual entry field.", "format":"double", "exampleSetFlag":false }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a scope assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentActualsTimePhasedCostDataInput":{ "title":"ApiEntityScopeAssignmentActualsTimePhasedCostDataInput", "required":[ "actualsCostProject", "scopeAssignmentActualsTimePhasedDataId" ], "type":"object", "properties":{ "scopeAssignmentActualsTimePhasedDataId":{ "type":"integer", "description":"Actuals time phased data ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualsCostProject":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This value is based on the project currency.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentActualsTimePhasedDataInput":{ "title":"ApiEntityScopeAssignmentActualsTimePhasedDataInput", "required":[ "date", "scopeAssignmentActualsTimePhasedCostData", "scopeItemAssignmentId" ], "type":"object", "properties":{ "date":{ "type":"string", "description":"The date on which work on a work package began.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentActualsTimePhasedCostData":{ "description":"An object containing the cost fields associated with the actuals time phased data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeAssignmentActualsTimePhasedCostDataInput" } ] }, "scopeAssignmentActualsTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope actuals time phased data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualsHours":{ "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
                                                                                                                                                                                                                                                                This is a manual entry field.", "format":"double", "exampleSetFlag":false }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a scope assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ScopeAssignmentActualsTimePhasedData object, a unique ScopeAssignmentActualsTimePhasedData object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                • scopeAssignmentActualsTimePhasedDataId
                                                                                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityScopeAssignmentBaselineTimePhasedCostData":{ "title":"ApiEntityScopeAssignmentBaselineTimePhasedCostData", "required":[ "baselineCost", "scopeAssignmentBaselineTimePhasedDataId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentBaselineTimePhasedDataId":{ "type":"integer", "description":"Time phased baseline data ID.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineCostProject":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "baselineCost":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentBaselineTimePhasedData":{ "title":"ApiEntityScopeAssignmentBaselineTimePhasedData", "required":[ "baselineHours", "baselineUnits", "date", "scopeItemAssignmentId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"Date used for updating the dates of scope assignments and work packages when they are not linked to activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentBaselineTimePhasedCostData":{ "description":"An object containing the cost fields associated with the baseline time phased data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeAssignmentBaselineTimePhasedCostData" } ] }, "scopeAssignmentBaselineTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of baseline data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineUnits":{ "type":"number", "description":"Revised quantity at the time the baseline was set.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "type":"number", "description":"Revised hours at the time the baseline was set.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentInstalledTimePhasedCostData":{ "title":"ApiEntityScopeAssignmentInstalledTimePhasedCostData", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentInstalledTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of installed cost data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "installedCostProject":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                                                                                                                                                                                                                  If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                                                                                                                                                                                                                  If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "installedCost":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                                                                                                                                                                                                                  If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                                                                                                                                                                                                                  If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentInstalledTimePhasedData":{ "title":"ApiEntityScopeAssignmentInstalledTimePhasedData", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"Date used for updating scope assignments and work packages when they are not linked to activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentInstalledTimePhasedCostData":{ "description":"An object containing the cost fields associated with the installed time phased data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedCostData" } ] }, "scopeAssignmentInstalledTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "installedUnits":{ "type":"number", "description":"The amount of material or product that has been installed to date.
                                                                                                                                                                                                                                                                  If the Progress Measure on the work package is set to Milestone Percent Complete, then Installed Quantity equals Revised Quantity multiplied by Milestone Progress Percent Complete.
                                                                                                                                                                                                                                                                  This field can be manually overridden if the Progress Measure is set to Physical Percent Complete, then Installed Quantity is manually entered and not calculated.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "milestones":{ "type":"array", "description":"The milestones associated with the installed time phased data.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentTimePhasedMilestone", "exampleSetFlag":false }, "types":[ "array" ] }, "installedHours":{ "type":"number", "description":"Hours spent on the scope assignment.
                                                                                                                                                                                                                                                                  Calculated as Installed Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentTimePhasedMilestone":{ "title":"ApiEntityScopeAssignmentTimePhasedMilestone", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentInstalledTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope assignment installed time phase data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignmentSpreadMilestoneId":{ "type":"integer", "description":"The unique identifier of a scope assignment spread milestone.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "milestoneProgressPercent":{ "maximum":1, "minimum":0, "type":"number", "description":"The milestone progress percent complete.", "format":"double", "exampleSetFlag":false }, "milestoneId":{ "type":"integer", "description":"The unique identifier of a rule of credit milestone.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The progress percentage complete per milestone for the scope assignment. The values are used to calculate Milestone Progress Percent Complete for the scope assignment.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentInstalledTimePhasedCostDataInput":{ "title":"ApiEntityScopeAssignmentInstalledTimePhasedCostDataInput", "type":"object", "properties":{ "scopeAssignmentInstalledTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of installed cost data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "installedCostProject":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                                                                                                                                                                                                                  If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                                                                                                                                                                                                                  If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentInstalledTimePhasedDataInput":{ "title":"ApiEntityScopeAssignmentInstalledTimePhasedDataInput", "required":[ "date", "installedHours", "installedUnits", "scopeItemAssignmentId" ], "type":"object", "properties":{ "date":{ "type":"string", "description":"Date used for updating scope assignments and work packages when they are not linked to activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentInstalledTimePhasedCostData":{ "description":"An object containing the cost fields associated with the installed time phased data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeAssignmentInstalledTimePhasedCostDataInput" } ] }, "scopeAssignmentInstalledTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "installedUnits":{ "type":"number", "description":"The amount of material or product that has been installed to date.
                                                                                                                                                                                                                                                                  If the Progress Measure on the work package is set to Milestone Percent Complete, then Installed Quantity equals Revised Quantity multiplied by Milestone Progress Percent Complete.
                                                                                                                                                                                                                                                                  This field can be manually overridden if the Progress Measure is set to Physical Percent Complete, then Installed Quantity is manually entered and not calculated.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "milestones":{ "type":"array", "description":"The milestones associated with the installed time phased data.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeAssignmentTimePhasedMilestoneInput", "exampleSetFlag":false }, "types":[ "array" ] }, "installedHours":{ "type":"number", "description":"Hours spent on the scope assignment.
                                                                                                                                                                                                                                                                  Calculated as Installed Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false } }, "description":"This entity represents a ScopeAssignmentInstalledTimePhasedData object, a unique ScopeAssignmentInstalledTimePhasedData object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                  • scopeAssignmentInstalledTimePhasedDataId
                                                                                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityScopeAssignmentTimePhasedMilestoneInput":{ "title":"ApiEntityScopeAssignmentTimePhasedMilestoneInput", "required":[ "milestoneId", "scopeAssignmentInstalledTimePhasedDataId" ], "type":"object", "properties":{ "scopeAssignmentInstalledTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope assignment installed time phase data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignmentSpreadMilestoneId":{ "type":"integer", "description":"The unique identifier of a scope assignment spread milestone.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "milestoneProgressPercent":{ "maximum":1, "minimum":0, "type":"number", "description":"The milestone progress percent complete.", "format":"double", "exampleSetFlag":false }, "milestoneId":{ "type":"integer", "description":"The unique identifier of a rule of credit milestone.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The progress percentage complete per milestone for the scope assignment. The values are used to calculate Milestone Progress Percent Complete for the scope assignment.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentPlannedTimePhasedCostData":{ "title":"ApiEntityScopeAssignmentPlannedTimePhasedCostData", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentPlannedTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope item planned cost data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedCostProject":{ "type":"number", "description":"Original cost for the project scope item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedCost":{ "type":"number", "description":"Original cost for the scope item. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentPlannedTimePhasedData":{ "title":"ApiEntityScopeAssignmentPlannedTimePhasedData", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "date":{ "type":"string", "description":"Date used for updating the dates of scope assignments and work packages when they are not linked to activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentPlannedTimePhasedCostData":{ "description":"An object containing the cost fields associated with the planned time phased data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedCostData" } ] }, "scopeAssignmentPlannedTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedUnits":{ "type":"number", "description":"Expected amount of material or product required for a scope item.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedHours":{ "type":"number", "description":"Expected hours needed to complete all the work on a scope item.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput":{ "title":"ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput", "required":[ "plannedCost", "scopeAssignmentPlannedTimePhasedDataId" ], "type":"object", "properties":{ "scopeAssignmentPlannedTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope item planned cost data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedCostProject":{ "type":"number", "description":"Original cost for the project scope item. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedCost":{ "type":"number", "description":"Original cost for the scope item. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityScopeAssignmentPlannedTimePhasedDataInput":{ "title":"ApiEntityScopeAssignmentPlannedTimePhasedDataInput", "required":[ "date", "plannedHours", "plannedUnits", "scopeItemAssignmentId" ], "type":"object", "properties":{ "date":{ "type":"string", "description":"Date used for updating the dates of scope assignments and work packages when they are not linked to activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentPlannedTimePhasedCostData":{ "description":"An object containing the cost fields associated with the planned time phased data.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeAssignmentPlannedTimePhasedCostDataInput" } ] }, "scopeAssignmentPlannedTimePhasedDataId":{ "type":"integer", "description":"The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedUnits":{ "type":"number", "description":"Expected amount of material or product required for a scope item.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedHours":{ "type":"number", "description":"Expected hours needed to complete all the work on a scope item.", "format":"double", "exampleSetFlag":false } }, "description":"This entity represents a ScopeAssignmentPlannedTimePhasedData object, a unique ScopeAssignmentPlannedTimePhasedData object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                    • scopeAssignmentPlannedTimePhasedDataId
                                                                                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityCodeValueScopeItem":{ "title":"ApiEntityCodeValueScopeItem", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueScopeItemId":{ "type":"integer", "description":"The unique identifier for the code value assigned to the scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemId":{ "type":"integer", "description":"The unique identifier of a scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeItem":{ "title":"ApiEntityScopeItem", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemCodeValue":{ "type":"array", "description":"The list of code values for a scope item. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueScopeItem", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details describing the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "etcAdjustedUnits":{ "type":"number", "description":"The scope item quantity that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
                                                                                                                                                                                                                                                                      This is a manual entry field.", "format":"double", "exampleSetFlag":false }, "approvedChangedUnits":{ "type":"number", "description":"The total quantity approved for scope item changes.", "format":"double", "exampleSetFlag":false }, "weightedUnits":{ "type":"number", "description":"The amount of material or product that has been weighted to date.
                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments created for the scope item.", "format":"double", "exampleSetFlag":false }, "pendingChangedUnits":{ "type":"number", "description":"The total quantity waiting for approval on a scope item.", "format":"double", "exampleSetFlag":false }, "actualUnitsToDate":{ "type":"number", "description":"The total amount of the scope item installed.
                                                                                                                                                                                                                                                                      Calculated as the sum of Installed Quantity for all scope assignments.", "format":"double", "exampleSetFlag":false }, "revisedUnits":{ "minimum":0, "type":"number", "description":"The total quantity that has been revised to account for approved changes for a scope item.
                                                                                                                                                                                                                                                                      Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.", "format":"double", "exampleSetFlag":false }, "scopeItemId":{ "type":"integer", "description":"The system-generated identifier of a scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "currentHoursPerUnit":{ "type":"number", "description":"The number of hours required to install a single quantity of the scope item material or product based on current values.
                                                                                                                                                                                                                                                                      For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable.
                                                                                                                                                                                                                                                                      This field is recalculated if Current Hours are changed.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "installedUnits":{ "type":"number", "description":"The amount of material or product that has been installed to date.
                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments created for the scope item.", "format":"double", "exampleSetFlag":false }, "costCategoryAbbr":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviation for the cost category name.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryType":{ "type":"string", "description":"The classification of the cost category.
                                                                                                                                                                                                                                                                      Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate.
                                                                                                                                                                                                                                                                      Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
                                                                                                                                                                                                                                                                      Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
                                                                                                                                                                                                                                                                      Other: Cost is manually entered as a lump sum.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LABOR", "EQUIPMENT", "MATERIALS", "OTHER" ] }, "percentComplete":{ "type":"number", "description":"Sum of Quantity Completed Weight for the scope items assigned to work packages divided by Revised Quantity for the scope item.", "format":"double", "exampleSetFlag":false }, "plannedUnits":{ "minimum":0, "type":"number", "description":"The original expected amount of material or product required for a scope item.", "format":"double", "exampleSetFlag":false }, "baselineUnits":{ "minimum":0, "type":"number", "description":"The total quantity that has not been distributed to work packages. This is the amount that is available for distribution to scope assignments. After the original baseline is set, this includes all approved quantity changes for scope items.", "format":"double", "exampleSetFlag":false }, "atCompletionUnits":{ "type":"number", "description":"The total amount of the scope item to be installed for the project.
                                                                                                                                                                                                                                                                      Calculated as Revised Quantity plus Adjusted Quantity.", "format":"double", "exampleSetFlag":false }, "remainingUnits":{ "type":"number", "description":"The quantity remaining for the scope item.
                                                                                                                                                                                                                                                                      Calculated as Revised Quantity for the scope item minus the sum of Installed Quantity for the scope item's assignments.", "format":"double", "exampleSetFlag":false }, "assignedUnits":{ "minimum":0, "type":"number", "description":"The total quantity distributed to work packages by way of scope assignments. After the original baseline is set, this number is updated to also reflect scope assignments that are created from approved quantity changes of the scope item.", "format":"double", "exampleSetFlag":false }, "assignedHours":{ "minimum":0, "type":"number", "description":"The total number of hours that have been distributed to work packages by way of scope assignments. After the original baseline is set, this number includes all approved hour changes.", "format":"double", "exampleSetFlag":false }, "plannedHoursPerUnit":{ "minimum":0, "type":"number", "description":"The number of hours required to install or assemble a single quantity of the scope item material or product.
                                                                                                                                                                                                                                                                      For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable.
                                                                                                                                                                                                                                                                      Calculated as Original Hours divided by Original Quantity.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "itemName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "unAssignedHours":{ "type":"number", "description":"The total number of hours that have not been distributed to work packages for a scope item. This is the amount that is available for distribution to scope assignments. After the original baselines is set, this includes all Approved Change Hours.", "format":"double", "exampleSetFlag":false }, "unAssignedUnits":{ "minimum":0, "type":"number", "description":"The total number of hours waiting for approval on a scope item.", "format":"double", "exampleSetFlag":false }, "itemNameUpper":{ "maxLength":255, "type":"string", "description":"The name of an upper scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "itemCodeUpper":{ "maxLength":60, "type":"string", "description":"The code of an upper scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "effectiveFinish":{ "type":"string", "description":"The latest Effective Finish date for Actual to Date values of all scope item's scope assignments.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "effectiveStart":{ "type":"string", "description":"The earliest Effective Start date for Actual to Date values of all the scope item's scope assignments.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of a cost category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedHours":{ "minimum":0, "type":"number", "description":"The original expected hours needed to complete all the work on a scope item.
                                                                                                                                                                                                                                                                      Calculated as Original Quantity multiplied by Original Productivity Rate.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"The total number of hours waiting for approval on a scope item.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The total number of hours approved for scope item changes.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "minimum":0, "type":"number", "description":"The total number of hours needed to complete all the work on a scope item, including any approved changes. This value equals the Original Hours before the original baseline is set.
                                                                                                                                                                                                                                                                      Calculated as the sum of Original Hours plus Approved Changed Hours, if any.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "minimum":0, "type":"number", "description":"The Revised Hours at the time the baseline was set.", "format":"double", "exampleSetFlag":false }, "unitOfMeasureId":{ "type":"integer", "description":"The name of the measurement type used to describe the quantity of a scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a scope item.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the scope item in the change request.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ] }, "pbsId":{ "type":"integer", "description":"The system-generated identifier of the parent PBS associated with the scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"A unique identifier for the PBS node.", "exampleSetFlag":false, "types":[ "string" ] }, "cbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeItemConfiguredFieldValue":{ "title":"ApiEntityScopeItemConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Scope Item Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemId":{ "type":"integer", "description":"The system-generated identifier of a Scope Item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueScopeItemInput":{ "title":"ApiEntityCodeValueScopeItemInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueScopeItemId":{ "type":"integer", "description":"The unique identifier for the code value assigned to the scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemId":{ "type":"integer", "description":"The unique identifier of a scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueScopeItem object, a unique CodeValueScopeItem object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                      • codeValueScopeItemId
                                                                                                                                                                                                                                                                      • codeValueId
                                                                                                                                                                                                                                                                      • codeTypeId,codeValueCode
                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode
                                                                                                                                                                                                                                                                      • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                                                                                      • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityScopeItemConfiguredFieldValueInput":{ "title":"ApiEntityScopeItemConfiguredFieldValueInput", "type":"object", "properties":{ "scopeItemConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Scope Item Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemId":{ "type":"integer", "description":"The system-generated identifier of a Scope Item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ScopeItemConfiguredFieldValue object, a unique ScopeItemConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                        • scopeItemConfiguredFieldValueId
                                                                                                                                                                                                                                                                        • columnDefinitionId
                                                                                                                                                                                                                                                                        • columnName
                                                                                                                                                                                                                                                                        • columnLabel
                                                                                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityScopeItemInput":{ "title":"ApiEntityScopeItemInput", "required":[ "itemName", "pbsId", "projectId", "scopeItemCode" ], "type":"object", "properties":{ "scopeItemCodeValue":{ "type":"array", "description":"The list of code values for a scope item. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueScopeItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "pbsCodeHierarchy":{ "type":"array", "description":"The list of PBS codes in hierarchical way.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Details describing the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "etcAdjustedUnits":{ "type":"number", "description":"The scope item quantity that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
                                                                                                                                                                                                                                                                          This is a manual entry field.", "format":"double", "exampleSetFlag":false }, "approvedChangedUnits":{ "type":"number", "description":"The total quantity approved for scope item changes.", "format":"double", "exampleSetFlag":false }, "weightedUnits":{ "type":"number", "description":"The amount of material or product that has been weighted to date.
                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments created for the scope item.", "format":"double", "exampleSetFlag":false }, "pendingChangedUnits":{ "type":"number", "description":"The total quantity waiting for approval on a scope item.", "format":"double", "exampleSetFlag":false }, "actualUnitsToDate":{ "type":"number", "description":"The total amount of the scope item installed.
                                                                                                                                                                                                                                                                          Calculated as the sum of Installed Quantity for all scope assignments.", "format":"double", "exampleSetFlag":false }, "revisedUnits":{ "minimum":0, "type":"number", "description":"The total quantity that has been revised to account for approved changes for a scope item.
                                                                                                                                                                                                                                                                          Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.", "format":"double", "exampleSetFlag":false }, "scopeItemId":{ "type":"integer", "description":"The system-generated identifier of a scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "currentHoursPerUnit":{ "type":"number", "description":"The number of hours required to install a single quantity of the scope item material or product based on current values.
                                                                                                                                                                                                                                                                          For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable.
                                                                                                                                                                                                                                                                          This field is recalculated if Current Hours are changed.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "installedUnits":{ "type":"number", "description":"The amount of material or product that has been installed to date.
                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments created for the scope item.", "format":"double", "exampleSetFlag":false }, "costCategoryAbbr":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviation for the cost category name.", "exampleSetFlag":false, "types":[ "string" ] }, "percentComplete":{ "type":"number", "description":"Sum of Quantity Completed Weight for the scope items assigned to work packages divided by Revised Quantity for the scope item.", "format":"double", "exampleSetFlag":false }, "plannedUnits":{ "minimum":0, "type":"number", "description":"The original expected amount of material or product required for a scope item.", "format":"double", "exampleSetFlag":false }, "baselineUnits":{ "minimum":0, "type":"number", "description":"The total quantity that has not been distributed to work packages. This is the amount that is available for distribution to scope assignments. After the original baseline is set, this includes all approved quantity changes for scope items.", "format":"double", "exampleSetFlag":false }, "atCompletionUnits":{ "type":"number", "description":"The total amount of the scope item to be installed for the project.
                                                                                                                                                                                                                                                                          Calculated as Revised Quantity plus Adjusted Quantity.", "format":"double", "exampleSetFlag":false }, "remainingUnits":{ "type":"number", "description":"The quantity remaining for the scope item.
                                                                                                                                                                                                                                                                          Calculated as Revised Quantity for the scope item minus the sum of Installed Quantity for the scope item's assignments.", "format":"double", "exampleSetFlag":false }, "assignedUnits":{ "minimum":0, "type":"number", "description":"The total quantity distributed to work packages by way of scope assignments. After the original baseline is set, this number is updated to also reflect scope assignments that are created from approved quantity changes of the scope item.", "format":"double", "exampleSetFlag":false }, "assignedHours":{ "minimum":0, "type":"number", "description":"The total number of hours that have been distributed to work packages by way of scope assignments. After the original baseline is set, this number includes all approved hour changes.", "format":"double", "exampleSetFlag":false }, "plannedHoursPerUnit":{ "minimum":0, "type":"number", "description":"The number of hours required to install or assemble a single quantity of the scope item material or product.
                                                                                                                                                                                                                                                                          For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable.
                                                                                                                                                                                                                                                                          Calculated as Original Hours divided by Original Quantity.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "itemName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "unAssignedHours":{ "type":"number", "description":"The total number of hours that have not been distributed to work packages for a scope item. This is the amount that is available for distribution to scope assignments. After the original baselines is set, this includes all Approved Change Hours.", "format":"double", "exampleSetFlag":false }, "unAssignedUnits":{ "minimum":0, "type":"number", "description":"The total number of hours waiting for approval on a scope item.", "format":"double", "exampleSetFlag":false }, "itemNameUpper":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of an upper scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "itemCodeUpper":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of an upper scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "effectiveFinish":{ "type":"string", "description":"The latest Effective Finish date for Actual to Date values of all scope item's scope assignments.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "effectiveStart":{ "type":"string", "description":"The earliest Effective Start date for Actual to Date values of all the scope item's scope assignments.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of a cost category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedHours":{ "minimum":0, "type":"number", "description":"The original expected hours needed to complete all the work on a scope item.
                                                                                                                                                                                                                                                                          Calculated as Original Quantity multiplied by Original Productivity Rate.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"The total number of hours waiting for approval on a scope item.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The total number of hours approved for scope item changes.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "minimum":0, "type":"number", "description":"The total number of hours needed to complete all the work on a scope item, including any approved changes. This value equals the Original Hours before the original baseline is set.
                                                                                                                                                                                                                                                                          Calculated as the sum of Original Hours plus Approved Changed Hours, if any.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "minimum":0, "type":"number", "description":"The Revised Hours at the time the baseline was set.", "format":"double", "exampleSetFlag":false }, "unitOfMeasureId":{ "type":"integer", "description":"The name of the measurement type used to describe the quantity of a scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a scope item.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The state of the scope item in the change request.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ] }, "pbsId":{ "type":"integer", "description":"The system-generated identifier of the parent PBS associated with the scope item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ScopeItem object, a unique ScopeItem object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                          • scopeItemId
                                                                                                                                                                                                                                                                          • scopeItemCode,pbsId,projectId
                                                                                                                                                                                                                                                                          • scopeItemCode,pbsCodeHierarchy,projectId
                                                                                                                                                                                                                                                                          • scopeItemCode,pbsId,projectCode,workspaceCode
                                                                                                                                                                                                                                                                          • scopeItemCode,pbsCodeHierarchy,projectCode,workspaceCode
                                                                                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityCodeValueScopeItemAssignment":{ "title":"ApiEntityCodeValueScopeItemAssignment", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueScopeItemId":{ "type":"integer", "description":"The unique identifier of a work package code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeItemAssignment":{ "title":"ApiEntityScopeItemAssignment", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "milestoneProgressPercent":{ "minimum":0, "type":"number", "description":"The percentage complete for all milestones for the scope assignment. The calculation is based on the user entered percentage complete for the milestone and the rules defined for the milestone calculations.", "format":"double", "exampleSetFlag":false }, "remainingEarlyFinishDate":{ "type":"string", "description":"The earliest date the work on the scope assignment is scheduled to finish.
                                                                                                                                                                                                                                                                            If there is no activity link, before the original baseline is set, this field is populated with the Original Finish date. After the original baseline is set, this field is populated with the Revised Finish date.
                                                                                                                                                                                                                                                                            This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
                                                                                                                                                                                                                                                                            If there is any activity linked, this field is populated with the activity's Remaining Early Finish date.
                                                                                                                                                                                                                                                                            This field is used to spread Remaining data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentCodeValue":{ "type":"array", "description":"The list of code values for a scope item assignment. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueScopeItemAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "effectiveDate":{ "type":"string", "description":"The latest date of all Actual to Date and Actual Cost to Date values for the scope assignment.
                                                                                                                                                                                                                                                                            This is a read-only field.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional details for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "effectiveStartDate":{ "type":"string", "description":"The earliest date of all Actual Hours to Date and Actual Cost to Date values for the scope assignment.
                                                                                                                                                                                                                                                                            This is a read-only field.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "remainingEarlyStartDate":{ "type":"string", "description":"The earliest date the work on the scope assignment is scheduled to begin.
                                                                                                                                                                                                                                                                            If there is no activity link, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, this field is populated with the Data Date when the Modify Dates feature is run if the scope assignment's Scope Percent Complete is not equal to 100%.
                                                                                                                                                                                                                                                                            This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
                                                                                                                                                                                                                                                                            If there is any activity linked, this field is populated with the activity's Remaining Early Start date.
                                                                                                                                                                                                                                                                            This field is used to spread Remaining data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinishDate":{ "type":"string", "description":"The date the work on the scope assignment is scheduled to finish.
                                                                                                                                                                                                                                                                            This field is used to spread original data fields.
                                                                                                                                                                                                                                                                            If there is no activity link, this field is populated with the Original Finish date until the original baseline is set. It can be manually modified after the original baseline is set.
                                                                                                                                                                                                                                                                            If Data Date is specified after the Planned Finish date is set and the Planned Start date is before the Data Date, the application sets the Planned Finish date to be the same date relative to Planned Start before the Data Date was modified when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                            If there is an activity link, this field is populated with the activity's Planned Finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStartDate":{ "type":"string", "description":"The latest possible date work on the scope assignment must begin without delaying the finish date.
                                                                                                                                                                                                                                                                            If there is no activity link, this field is always equal to the Remaining Early Start date.
                                                                                                                                                                                                                                                                            If there is any activity link, this field is populated with the activity's Remaining Late Start date.
                                                                                                                                                                                                                                                                            This field is used to spread Remaining data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinishDate":{ "type":"string", "description":"The latest possible date work on the scope assignment must finish to not delay the finish date.
                                                                                                                                                                                                                                                                            If there is no activity link, this field is always equal to the Remaining Early Finish date.
                                                                                                                                                                                                                                                                            If there is any activity linked, this field is populated with the activity's Remaining Late Finish date.
                                                                                                                                                                                                                                                                            This field is used to spread Remaining data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedStartDate":{ "type":"string", "description":"The date the work on the scope assignment is scheduled to begin.
                                                                                                                                                                                                                                                                            This field is used to spread original data fields.
                                                                                                                                                                                                                                                                            If there is no activity link, this field is populated with the Original Start date until the original baseline is set. It can be manually updated after the original baseline is set.
                                                                                                                                                                                                                                                                            If the Data Date is specified, the date cannot be set to a date earlier than the Data Date.
                                                                                                                                                                                                                                                                            If the Data Date is specified after the Planned Start date is set, the Planned Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, that is Installed Quantity is zero, then the date inherits the Data Date when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                            If there is an activity link, this field is populated with the activity's Planned Start date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageId":{ "type":"integer", "description":"The unique identifier for the work package.The work package object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manualWeightFactor":{ "type":"number", "description":"The value used to calculate manual completed weight when progress needs to be weighed against a factor other than quantity, hours, or cost.
                                                                                                                                                                                                                                                                            This is a manual entry field when Scope Percent Complete Weight Method is set to Manual.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "manualWeight":{ "type":"number", "description":"Calculated as Scope Percent Complete multiplied by Manual Weight.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scopeItemAssignmentCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentCost":{ "description":"An object containing scope assignment cost fields.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentCost" } ] }, "availableUnits":{ "minimum":0, "type":"number", "description":"The amount of material or product available for scope assignment.
                                                                                                                                                                                                                                                                            Calculated as Revised Quantity minus Installed Quantity.", "format":"double", "exampleSetFlag":false }, "etcAdjustedUnits":{ "type":"number", "description":"The scope assignment quantity that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.", "format":"double", "exampleSetFlag":false }, "approvedChangedUnits":{ "type":"number", "description":"Calculated as the sum of all approved change quantities in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "eacUnits":{ "minimum":0, "type":"number", "description":"The estimate of how much material or product will be installed at completion of the scope assignment work.
                                                                                                                                                                                                                                                                            Calculated as ETC Quantity plus Actual Quantity to Date.", "format":"double", "exampleSetFlag":false }, "availableHours":{ "type":"number", "description":"The number of hours available for scope assignment.
                                                                                                                                                                                                                                                                            Calculated as Revised Hours minus Installed Hours.", "format":"double", "exampleSetFlag":false }, "weightedCost":{ "minimum":0, "type":"number", "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Cost.
                                                                                                                                                                                                                                                                            Calculated as Scope Percent Complete times Revised Cost. This field is in base currency and is calculated from weightedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "weightedUnits":{ "minimum":0, "type":"number", "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Quantity.
                                                                                                                                                                                                                                                                            Calculated as Scope Percent Complete multiplied by Revised Quantity.", "format":"double", "exampleSetFlag":false }, "pendingChangedUnits":{ "type":"number", "description":"The sum of all pending change quantities in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "weightedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Hours.
                                                                                                                                                                                                                                                                            Calculated as Scope Percent Complete times Revised Hours.", "format":"double", "exampleSetFlag":false }, "actualUnitsToDate":{ "type":"number", "description":"The Installed Quantity for the scope assignment.", "format":"double", "exampleSetFlag":false }, "revisedUnits":{ "minimum":0, "type":"number", "description":"The total quantity that has been revised to account for approved changes for a scope assignment. This value equals the Original Quantity before the original baseline is set.
                                                                                                                                                                                                                                                                            Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.", "format":"double", "exampleSetFlag":false }, "etcUnits":{ "type":"number", "description":"The estimate of how much quantity is needed to complete the work.
                                                                                                                                                                                                                                                                            Calculated as BAC Quantity minus Earned Quantity.", "format":"double", "exampleSetFlag":false }, "hoursPerUnit":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"The number of hours it takes to install or assemble the product or material per unit. Defaults to the scope item's Original Productivity Rate, but can be updated for each scope item assignment.
                                                                                                                                                                                                                                                                            Calculated as Original Hours divided by Original Quantity.
                                                                                                                                                                                                                                                                            If this field is updated, Original Hours is recalculated to equal Original Quantity multiplied by Original Productivity Rate.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "earnedUnits":{ "minimum":0, "type":"number", "description":"The amount of material or product that has been installed based on the Performance Percent Complete of the scope assignment and the Budget At Completion Quantity.
                                                                                                                                                                                                                                                                            Calculated as Performance Percent Complete multiplied by BAC Quantity.", "format":"double", "exampleSetFlag":false }, "earnedPercentComplete":{ "minimum":0, "type":"number", "description":"Calculated as Installed Quantity divided by At Completion Quantity.", "format":"double", "exampleSetFlag":false }, "scopeItemId":{ "type":"integer", "description":"The unique identifier for the scope item.The scope item object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "bacUnits":{ "type":"number", "description":"The Revised Quantity or At Completion Quantity at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Quantity of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "progressStatus":{ "type":"string", "description":"The current status of a scope assignment.
                                                                                                                                                                                                                                                                            Not Started: Work using the scope assignment has not begun.
                                                                                                                                                                                                                                                                            In Progress: The work is in progress.
                                                                                                                                                                                                                                                                            Completed: The work has been completed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "currentHoursPerUnit":{ "type":"number", "description":"The number of hours it will take to install or assemble the product or material per unit based on current values.
                                                                                                                                                                                                                                                                            Calculated as Revised Hours divided by Revised Quantity.
                                                                                                                                                                                                                                                                            This value is recalculated if Revised Quantity or Revised Hours are changed.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "installedUnits":{ "minimum":0, "type":"number", "description":"The amount of material or product that has been installed to date.
                                                                                                                                                                                                                                                                            If the Progress Measure on the work package is set to Milestone Percent Complete, then Installed Quantity equals Revised Quantity multiplied by Milestone Progress Percent Complete.
                                                                                                                                                                                                                                                                            This field can be manually overridden if the Progress Measure is set to Physical Percent Complete, then Installed Quantity is manually entered and not calculated.", "format":"double", "exampleSetFlag":false }, "originalStartDate":{ "type":"string", "description":"The date the work on the scope assignment is scheduled to begin.
                                                                                                                                                                                                                                                                            This field is populated with its work package's Original Start, but can be manually modified until the original baseline is set.
                                                                                                                                                                                                                                                                            If there is no activity link, the field is locked when the original baseline is set.
                                                                                                                                                                                                                                                                            If there is an activity link, before the original baseline is set the field is populated with the activity's Planned Start. After the baseline is set, the field is locked.
                                                                                                                                                                                                                                                                            If the Data Date is specified, the date cannot be set to a date earlier than the Data Date.
                                                                                                                                                                                                                                                                            If the Data Date is specified after the Original Start date is set and the Original Start date is before the Data Date, the Original Start date inherits the Data Date when the Modify Dates feature is run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "originalFinishDate":{ "type":"string", "description":"The date the work on the scope assignment is scheduled to finish.
                                                                                                                                                                                                                                                                            This field is populated with the work package's Original Finish date, but it can be manually modified until the original baseline is set.
                                                                                                                                                                                                                                                                            If there is no activity link, the field is locked when the original baseline is set.
                                                                                                                                                                                                                                                                            If there is an activity link, before the original baseline is set the field is populated with the activity's Planned Finish. After the baseline is set, the field is locked.
                                                                                                                                                                                                                                                                            If the Data Date is specified after the Original Finish date is set and the Original Start date is before the Data Date, the application sets the Original Finish date to be the same date relative to Original Start before the Data Date was modified when the Modify Dates feature is run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "revisedStartDate":{ "type":"string", "description":"The revised start date for the scope assignment.
                                                                                                                                                                                                                                                                            It is always the earliest start of the scope assignment's Planned Start date and all approved Change Start dates.
                                                                                                                                                                                                                                                                            This field is used to spread Revised data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "revisedFinishDate":{ "type":"string", "description":"The revised finish date for the scope assignment.
                                                                                                                                                                                                                                                                            It is always the latest finish of the scope assignment's Planned Finish date and all approved Change Finish dates.
                                                                                                                                                                                                                                                                            This field is used to spread Revised data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "installedStartDate":{ "type":"string", "description":"The date work on the scope assignment began.
                                                                                                                                                                                                                                                                            This is the earliest date of all Installed Quantity values for the scope assignment.
                                                                                                                                                                                                                                                                            This field is used to spread Installed data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "installedFinishDate":{ "type":"string", "description":"The date work on the scope assignment completed.
                                                                                                                                                                                                                                                                            The latest date of all Installed Quantity values for the scope assignment when Scope Percent Complete equals 100%.
                                                                                                                                                                                                                                                                            This field is used to spread Installed data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineStartDate":{ "type":"string", "description":"The planned start date for the scope assignment as is set in the current baseline.
                                                                                                                                                                                                                                                                            This field is used to spread baseline data fields.
                                                                                                                                                                                                                                                                            This field is populated with the Revised Start date at the time that the current baseline is set.
                                                                                                                                                                                                                                                                            If there is an activity link, this field is populated with the activity's Current BL Start date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineFinishDate":{ "type":"string", "description":"The planned finish date for the scope assignment as is set in the current baseline.
                                                                                                                                                                                                                                                                            This field is used to spread baseline data fields.
                                                                                                                                                                                                                                                                            This field is populated with the Revised Finish date at the time that the current baseline is set.
                                                                                                                                                                                                                                                                            If there is an activity link, this field is populated with the activity's Current BL Finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "weightedCostProject":{ "minimum":0, "type":"number", "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Cost. Calculated as Scope Percent Complete times Revised Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "lastInstalledDate":{ "type":"string", "description":"The date on which the work package was last installed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryAbbr":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviation for the cost category name.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryType":{ "type":"string", "description":"The classification of the cost category.
                                                                                                                                                                                                                                                                            Labor: Calculates Cost of the project as Quantity multiplied by Production Rate multiplied by Labor Rate.
                                                                                                                                                                                                                                                                            Equipment: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
                                                                                                                                                                                                                                                                            Materials: Calculates Cost of the project as Quantity multiplied by Unit Rate multiplied by Labor Rate.
                                                                                                                                                                                                                                                                            Other: Cost is manually entered as a lump sum.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "LABOR", "EQUIPMENT", "MATERIALS", "OTHER" ] }, "percentComplete":{ "minimum":0, "type":"number", "description":"Calculated as Installed Quantity divided by At Completion Quantity.", "format":"double", "exampleSetFlag":false }, "plannedUnits":{ "minimum":0, "type":"number", "description":"The expected amount of material or product required.", "format":"double", "exampleSetFlag":false }, "baselineUnits":{ "minimum":0, "type":"number", "description":"The Revised Quantity at the time the current baseline was set.", "format":"double", "exampleSetFlag":false }, "atCompletionUnits":{ "type":"number", "description":"The total amount of the scope item to be installed for the scope assignment.
                                                                                                                                                                                                                                                                            Calculated as Revised Quantity plus Adjusted Quantity.", "format":"double", "exampleSetFlag":false }, "remainingUnits":{ "type":"number", "description":"The quantity remaining for the scope assignment.
                                                                                                                                                                                                                                                                            Calculated as Revised Quantity minus Installed Quantity.", "format":"double", "exampleSetFlag":false }, "managerId":{ "type":"integer", "description":"The manager or person responsible for providing status on the scope assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "milestones":{ "type":"array", "description":"The milestones of a scope assignment.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentMilestone", "exampleSetFlag":false }, "types":[ "array" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of a cost category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
                                                                                                                                                                                                                                                                            Calculated as Original Quantity multiplied by Original Productivity Rate.
                                                                                                                                                                                                                                                                            Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"Calculated as the sum of all pending hour changes in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The sum of all approved change hours in the change and transfer records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"The Revised Hours at the time the baseline was set.", "format":"double", "exampleSetFlag":false }, "etcHours":{ "type":"number", "description":"The estimated number of hours needed to complete the work.
                                                                                                                                                                                                                                                                            Calculated as BAC Hours minus Earned Hours.", "format":"double", "exampleSetFlag":false }, "eacHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"Calculated as ETC Hours plus Actual Hours to Date.", "format":"double", "exampleSetFlag":false }, "earnedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.", "format":"double", "exampleSetFlag":false }, "etcAdjustedHours":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.", "format":"double", "exampleSetFlag":false }, "actualHoursToDate":{ "minimum":0, "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "bacHours":{ "type":"number", "description":"The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "remainingHours":{ "type":"number", "description":"The number of hours left for the scope assignment.
                                                                                                                                                                                                                                                                            Calculated as Remaining Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false }, "installedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"Hours spent on the scope assignment.
                                                                                                                                                                                                                                                                            Calculated as Installed Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false }, "atCompletionHours":{ "type":"number", "description":"The total hours expected for the scope assignment.
                                                                                                                                                                                                                                                                            Calculated as Revised Hours plus Adjusted Hours.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a scope item assignment.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of a work package.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ] }, "rateBy":{ "type":"string", "description":"Determines whether the cost is calculated using the Quantity or Hours.
                                                                                                                                                                                                                                                                            Quantity: Quantity is used to calculate cost. For example, Original Cost is calculated as Original Quantity times Original Cost Rate.
                                                                                                                                                                                                                                                                            Hours: Hours are used to calculate cost. For example, Original Cost is calculated as Original Hours times Original Cost Rate.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HOURS", "QUANTITY" ] }, "curve":{ "type":"integer", "description":"The curve profile selected for the scope assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentConfiguredFieldValue":{ "title":"ApiEntityScopeItemAssignmentConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Scope Assignment Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentCost":{ "title":"ApiEntityScopeItemAssignmentCost", "required":[ "scopeItemAssignmentId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "pendingChangedCostProject":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostProject":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedCostProject":{ "type":"number", "description":"The original cost of the scope assignment. If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours. If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity. This value is based on the project currency. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "revisedCostProject":{ "type":"number", "description":"The revised cost of the project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "eacCostProject":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "etcCostProject":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated as BAC Cost minus Earned Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "earnedCostProject":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "baselineCostProject":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateProject":{ "minimum":0, "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentRate":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This value is based on the project currency. This field is in base currency and is calculated from currentRateProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "rateProject":{ "minimum":0, "type":"number", "description":"The rate for the project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "bacCostProject":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"The total cost at the completion of the scope assignment. Calculated as Revised Cost plus Adjusted Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingCostProject":{ "type":"number", "description":"The remaining cost for the project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "installedCostProject":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date. If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours. If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostProject":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentRateProject":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This value is based on the project currency. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedCost":{ "type":"number", "description":"The original cost of the scope assignment. If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours. If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingChangedCost":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. This field is in base currency and is calculated from pendingChangedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedChangedCost":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment. This field is in base currency and is calculated from approvedChangedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "revisedCost":{ "type":"number", "description":"The revised cost of the project. This field is in base currency and is calculated from revisedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "baselineCost":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedCost":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. This field is in base currency and is calculated from earnedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostToDate":{ "minimum":0, "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This field is in base currency and is calculated from actualCostToDateProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The remaining cost for the project. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "installedCost":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date. If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours. If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "adjustedCost":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. This field is in base currency and is calculated from adjustedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The total cost at the completion of the scope assignment. Calculated as Revised Cost plus Adjusted Cost. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "etcCost":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated as BAC Cost minus Earned Cost. This field is in base currency and is calculated from etcCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "eacCost":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. This field is in base currency and is calculated from eacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "bacCost":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. This field is in base currency and is calculated from bacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "rate":{ "minimum":0, "type":"number", "description":"The rate for the project. This field is in base currency and is calculated from rateProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentMilestone":{ "title":"ApiEntityScopeItemAssignmentMilestone", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentMilestoneId":{ "type":"integer", "description":"Unique identifier of the scope item assignment milestone.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "milestoneProgressPercent":{ "maximum":1, "minimum":0, "type":"number", "description":"The progress percentage complete per milestone for the scope assignment. The values are used to calculate Milestone Progress Percent Complete for the scope assignment.", "format":"double", "exampleSetFlag":false }, "milestone":{ "description":"A milestone assigned to a scope assignment.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestone" } ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The user entered percentage complete for the individual milestones for the scope assignment.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueScopeItemAssignmentInput":{ "title":"ApiEntityCodeValueScopeItemAssignmentInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueScopeItemId":{ "type":"integer", "description":"The unique identifier of a work package code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueScopeItemAssignment object, a unique CodeValueScopeItemAssignment object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                            • codeValueScopeItemId
                                                                                                                                                                                                                                                                            • codeValueId
                                                                                                                                                                                                                                                                            • codeTypeId,codeValueCode
                                                                                                                                                                                                                                                                            • codeTypeCode,codeValueCode
                                                                                                                                                                                                                                                                            • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                                                                                            • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                                                                            • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                                                                                            • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                                                                                            • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                                                                                            • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentConfiguredFieldValueInput":{ "title":"ApiEntityScopeItemAssignmentConfiguredFieldValueInput", "type":"object", "properties":{ "scopeItemAssignmentConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Scope Assignment Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a ScopeItemAssignmentConfiguredFieldValue object, a unique ScopeItemAssignmentConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                              • scopeItemAssignmentConfiguredFieldValueId
                                                                                                                                                                                                                                                                              • columnDefinitionId
                                                                                                                                                                                                                                                                              • columnName
                                                                                                                                                                                                                                                                              • columnLabel
                                                                                                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentCostInput":{ "title":"ApiEntityScopeItemAssignmentCostInput", "required":[ "scopeItemAssignmentId" ], "type":"object", "properties":{ "pendingChangedCostProject":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "approvedChangedCostProject":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedCostProject":{ "type":"number", "description":"The original cost of the scope assignment. If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours. If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity. This value is based on the project currency. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "revisedCostProject":{ "type":"number", "description":"The revised cost of the project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "eacCostProject":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "etcCostProject":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated as BAC Cost minus Earned Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "earnedCostProject":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "baselineCostProject":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateProject":{ "minimum":0, "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "rateProject":{ "minimum":0, "type":"number", "description":"The rate for the project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "bacCostProject":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"The total cost at the completion of the scope assignment. Calculated as Revised Cost plus Adjusted Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingCostProject":{ "type":"number", "description":"The remaining cost for the project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "installedCostProject":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date. If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours. If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostProject":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "currentRateProject":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost. This value is based on the project currency. This value is based on the project currency.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentInput":{ "title":"ApiEntityScopeItemAssignmentInput", "required":[ "projectId", "scopeItemId", "workPackageId" ], "type":"object", "properties":{ "milestoneProgressPercent":{ "minimum":0, "type":"number", "description":"The percentage complete for all milestones for the scope assignment. The calculation is based on the user entered percentage complete for the milestone and the rules defined for the milestone calculations.", "format":"double", "exampleSetFlag":false }, "remainingEarlyFinishDate":{ "type":"string", "description":"The earliest date the work on the scope assignment is scheduled to finish.
                                                                                                                                                                                                                                                                                If there is no activity link, before the original baseline is set, this field is populated with the Original Finish date. After the original baseline is set, this field is populated with the Revised Finish date.
                                                                                                                                                                                                                                                                                This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
                                                                                                                                                                                                                                                                                If there is any activity linked, this field is populated with the activity's Remaining Early Finish date.
                                                                                                                                                                                                                                                                                This field is used to spread Remaining data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentCodeValue":{ "type":"array", "description":"The list of code values for a scope item assignment. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueScopeItemAssignmentInput", "exampleSetFlag":false }, "types":[ "array" ] }, "cbsCodes":{ "type":"array", "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "effectiveDate":{ "type":"string", "description":"The latest date of all Actual to Date and Actual Cost to Date values for the scope assignment.
                                                                                                                                                                                                                                                                                This is a read-only field.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Additional details for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "effectiveStartDate":{ "type":"string", "description":"The earliest date of all Actual Hours to Date and Actual Cost to Date values for the scope assignment.
                                                                                                                                                                                                                                                                                This is a read-only field.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the cost category.", "exampleSetFlag":false, "types":[ "string" ] }, "remainingEarlyStartDate":{ "type":"string", "description":"The earliest date the work on the scope assignment is scheduled to begin.
                                                                                                                                                                                                                                                                                If there is no activity link, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, this field is populated with the Data Date when the Modify Dates feature is run if the scope assignment's Scope Percent Complete is not equal to 100%.
                                                                                                                                                                                                                                                                                This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
                                                                                                                                                                                                                                                                                If there is any activity linked, this field is populated with the activity's Remaining Early Start date.
                                                                                                                                                                                                                                                                                This field is used to spread Remaining data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinishDate":{ "type":"string", "description":"The date the work on the scope assignment is scheduled to finish.
                                                                                                                                                                                                                                                                                This field is used to spread original data fields.
                                                                                                                                                                                                                                                                                If there is no activity link, this field is populated with the Original Finish date until the original baseline is set. It can be manually modified after the original baseline is set.
                                                                                                                                                                                                                                                                                If Data Date is specified after the Planned Finish date is set and the Planned Start date is before the Data Date, the application sets the Planned Finish date to be the same date relative to Planned Start before the Data Date was modified when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                If there is an activity link, this field is populated with the activity's Planned Finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStartDate":{ "type":"string", "description":"The latest possible date work on the scope assignment must begin without delaying the finish date.
                                                                                                                                                                                                                                                                                If there is no activity link, this field is always equal to the Remaining Early Start date.
                                                                                                                                                                                                                                                                                If there is any activity link, this field is populated with the activity's Remaining Late Start date.
                                                                                                                                                                                                                                                                                This field is used to spread Remaining data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinishDate":{ "type":"string", "description":"The latest possible date work on the scope assignment must finish to not delay the finish date.
                                                                                                                                                                                                                                                                                If there is no activity link, this field is always equal to the Remaining Early Finish date.
                                                                                                                                                                                                                                                                                If there is any activity linked, this field is populated with the activity's Remaining Late Finish date.
                                                                                                                                                                                                                                                                                This field is used to spread Remaining data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedStartDate":{ "type":"string", "description":"The date the work on the scope assignment is scheduled to begin.
                                                                                                                                                                                                                                                                                This field is used to spread original data fields.
                                                                                                                                                                                                                                                                                If there is no activity link, this field is populated with the Original Start date until the original baseline is set. It can be manually updated after the original baseline is set.
                                                                                                                                                                                                                                                                                If the Data Date is specified, the date cannot be set to a date earlier than the Data Date.
                                                                                                                                                                                                                                                                                If the Data Date is specified after the Planned Start date is set, the Planned Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, that is Installed Quantity is zero, then the date inherits the Data Date when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                If there is an activity link, this field is populated with the activity's Planned Start date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageId":{ "type":"integer", "description":"The unique identifier for the work package.The work package object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for the scope item assigned to the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manualWeightFactor":{ "type":"number", "description":"The value used to calculate manual completed weight when progress needs to be weighed against a factor other than quantity, hours, or cost.
                                                                                                                                                                                                                                                                                This is a manual entry field when Scope Percent Complete Weight Method is set to Manual.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "manualWeight":{ "type":"number", "description":"Calculated as Scope Percent Complete multiplied by Manual Weight.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scopeItemAssignmentCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentCost":{ "description":"An object containing scope assignment cost fields.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentCostInput" } ] }, "availableUnits":{ "minimum":0, "type":"number", "description":"The amount of material or product available for scope assignment.
                                                                                                                                                                                                                                                                                Calculated as Revised Quantity minus Installed Quantity.", "format":"double", "exampleSetFlag":false }, "etcAdjustedUnits":{ "type":"number", "description":"The scope assignment quantity that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.", "format":"double", "exampleSetFlag":false }, "approvedChangedUnits":{ "type":"number", "description":"Calculated as the sum of all approved change quantities in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "eacUnits":{ "minimum":0, "type":"number", "description":"The estimate of how much material or product will be installed at completion of the scope assignment work.
                                                                                                                                                                                                                                                                                Calculated as ETC Quantity plus Actual Quantity to Date.", "format":"double", "exampleSetFlag":false }, "availableHours":{ "type":"number", "description":"The number of hours available for scope assignment.
                                                                                                                                                                                                                                                                                Calculated as Revised Hours minus Installed Hours.", "format":"double", "exampleSetFlag":false }, "weightedCost":{ "minimum":0, "type":"number", "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Cost.
                                                                                                                                                                                                                                                                                Calculated as Scope Percent Complete times Revised Cost. This field is in base currency and is calculated from weightedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "weightedUnits":{ "minimum":0, "type":"number", "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Quantity.
                                                                                                                                                                                                                                                                                Calculated as Scope Percent Complete multiplied by Revised Quantity.", "format":"double", "exampleSetFlag":false }, "pendingChangedUnits":{ "type":"number", "description":"The sum of all pending change quantities in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "weightedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Hours.
                                                                                                                                                                                                                                                                                Calculated as Scope Percent Complete times Revised Hours.", "format":"double", "exampleSetFlag":false }, "actualUnitsToDate":{ "type":"number", "description":"The Installed Quantity for the scope assignment.", "format":"double", "exampleSetFlag":false }, "revisedUnits":{ "minimum":0, "type":"number", "description":"The total quantity that has been revised to account for approved changes for a scope assignment. This value equals the Original Quantity before the original baseline is set.
                                                                                                                                                                                                                                                                                Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.", "format":"double", "exampleSetFlag":false }, "etcUnits":{ "type":"number", "description":"The estimate of how much quantity is needed to complete the work.
                                                                                                                                                                                                                                                                                Calculated as BAC Quantity minus Earned Quantity.", "format":"double", "exampleSetFlag":false }, "hoursPerUnit":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"The number of hours it takes to install or assemble the product or material per unit. Defaults to the scope item's Original Productivity Rate, but can be updated for each scope item assignment.
                                                                                                                                                                                                                                                                                Calculated as Original Hours divided by Original Quantity.
                                                                                                                                                                                                                                                                                If this field is updated, Original Hours is recalculated to equal Original Quantity multiplied by Original Productivity Rate.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "earnedUnits":{ "minimum":0, "type":"number", "description":"The amount of material or product that has been installed based on the Performance Percent Complete of the scope assignment and the Budget At Completion Quantity.
                                                                                                                                                                                                                                                                                Calculated as Performance Percent Complete multiplied by BAC Quantity.", "format":"double", "exampleSetFlag":false }, "earnedPercentComplete":{ "minimum":0, "type":"number", "description":"Calculated as Installed Quantity divided by At Completion Quantity.", "format":"double", "exampleSetFlag":false }, "scopeItemId":{ "type":"integer", "description":"The unique identifier for the scope item.The scope item object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "bacUnits":{ "type":"number", "description":"The Revised Quantity or At Completion Quantity at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Quantity of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "progressStatus":{ "type":"string", "description":"The current status of a scope assignment.
                                                                                                                                                                                                                                                                                Not Started: Work using the scope assignment has not begun.
                                                                                                                                                                                                                                                                                In Progress: The work is in progress.
                                                                                                                                                                                                                                                                                Completed: The work has been completed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ] }, "currentHoursPerUnit":{ "type":"number", "description":"The number of hours it will take to install or assemble the product or material per unit based on current values.
                                                                                                                                                                                                                                                                                Calculated as Revised Hours divided by Revised Quantity.
                                                                                                                                                                                                                                                                                This value is recalculated if Revised Quantity or Revised Hours are changed.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "installedUnits":{ "minimum":0, "type":"number", "description":"The amount of material or product that has been installed to date.
                                                                                                                                                                                                                                                                                If the Progress Measure on the work package is set to Milestone Percent Complete, then Installed Quantity equals Revised Quantity multiplied by Milestone Progress Percent Complete.
                                                                                                                                                                                                                                                                                This field can be manually overridden if the Progress Measure is set to Physical Percent Complete, then Installed Quantity is manually entered and not calculated.", "format":"double", "exampleSetFlag":false }, "originalStartDate":{ "type":"string", "description":"The date the work on the scope assignment is scheduled to begin.
                                                                                                                                                                                                                                                                                This field is populated with its work package's Original Start, but can be manually modified until the original baseline is set.
                                                                                                                                                                                                                                                                                If there is no activity link, the field is locked when the original baseline is set.
                                                                                                                                                                                                                                                                                If there is an activity link, before the original baseline is set the field is populated with the activity's Planned Start. After the baseline is set, the field is locked.
                                                                                                                                                                                                                                                                                If the Data Date is specified, the date cannot be set to a date earlier than the Data Date.
                                                                                                                                                                                                                                                                                If the Data Date is specified after the Original Start date is set and the Original Start date is before the Data Date, the Original Start date inherits the Data Date when the Modify Dates feature is run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "originalFinishDate":{ "type":"string", "description":"The date the work on the scope assignment is scheduled to finish.
                                                                                                                                                                                                                                                                                This field is populated with the work package's Original Finish date, but it can be manually modified until the original baseline is set.
                                                                                                                                                                                                                                                                                If there is no activity link, the field is locked when the original baseline is set.
                                                                                                                                                                                                                                                                                If there is an activity link, before the original baseline is set the field is populated with the activity's Planned Finish. After the baseline is set, the field is locked.
                                                                                                                                                                                                                                                                                If the Data Date is specified after the Original Finish date is set and the Original Start date is before the Data Date, the application sets the Original Finish date to be the same date relative to Original Start before the Data Date was modified when the Modify Dates feature is run.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "revisedStartDate":{ "type":"string", "description":"The revised start date for the scope assignment.
                                                                                                                                                                                                                                                                                It is always the earliest start of the scope assignment's Planned Start date and all approved Change Start dates.
                                                                                                                                                                                                                                                                                This field is used to spread Revised data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "revisedFinishDate":{ "type":"string", "description":"The revised finish date for the scope assignment.
                                                                                                                                                                                                                                                                                It is always the latest finish of the scope assignment's Planned Finish date and all approved Change Finish dates.
                                                                                                                                                                                                                                                                                This field is used to spread Revised data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "installedStartDate":{ "type":"string", "description":"The date work on the scope assignment began.
                                                                                                                                                                                                                                                                                This is the earliest date of all Installed Quantity values for the scope assignment.
                                                                                                                                                                                                                                                                                This field is used to spread Installed data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "installedFinishDate":{ "type":"string", "description":"The date work on the scope assignment completed.
                                                                                                                                                                                                                                                                                The latest date of all Installed Quantity values for the scope assignment when Scope Percent Complete equals 100%.
                                                                                                                                                                                                                                                                                This field is used to spread Installed data fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineStartDate":{ "type":"string", "description":"The planned start date for the scope assignment as is set in the current baseline.
                                                                                                                                                                                                                                                                                This field is used to spread baseline data fields.
                                                                                                                                                                                                                                                                                This field is populated with the Revised Start date at the time that the current baseline is set.
                                                                                                                                                                                                                                                                                If there is an activity link, this field is populated with the activity's Current BL Start date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineFinishDate":{ "type":"string", "description":"The planned finish date for the scope assignment as is set in the current baseline.
                                                                                                                                                                                                                                                                                This field is used to spread baseline data fields.
                                                                                                                                                                                                                                                                                This field is populated with the Revised Finish date at the time that the current baseline is set.
                                                                                                                                                                                                                                                                                If there is an activity link, this field is populated with the activity's Current BL Finish date.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "weightedCostProject":{ "minimum":0, "type":"number", "description":"This value is used to calculate Scope Percent Complete at the work package level if Scope Percent Complete Weight Method is set to Cost. Calculated as Scope Percent Complete times Revised Cost. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "lastInstalledDate":{ "type":"string", "description":"The date on which the work package was last installed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "costCategoryAbbr":{ "maxLength":10, "minLength":1, "type":"string", "description":"The abbreviation for the cost category name.", "exampleSetFlag":false, "types":[ "string" ] }, "percentComplete":{ "minimum":0, "type":"number", "description":"Calculated as Installed Quantity divided by At Completion Quantity.", "format":"double", "exampleSetFlag":false }, "plannedUnits":{ "minimum":0, "type":"number", "description":"The expected amount of material or product required.", "format":"double", "exampleSetFlag":false }, "baselineUnits":{ "minimum":0, "type":"number", "description":"The Revised Quantity at the time the current baseline was set.", "format":"double", "exampleSetFlag":false }, "atCompletionUnits":{ "type":"number", "description":"The total amount of the scope item to be installed for the scope assignment.
                                                                                                                                                                                                                                                                                Calculated as Revised Quantity plus Adjusted Quantity.", "format":"double", "exampleSetFlag":false }, "remainingUnits":{ "type":"number", "description":"The quantity remaining for the scope assignment.
                                                                                                                                                                                                                                                                                Calculated as Revised Quantity minus Installed Quantity.", "format":"double", "exampleSetFlag":false }, "managerId":{ "type":"integer", "description":"The manager or person responsible for providing status on the scope assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "milestones":{ "type":"array", "description":"The milestones of a scope assignment.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentMilestoneInput", "exampleSetFlag":false }, "types":[ "array" ] }, "costCategoryId":{ "type":"integer", "description":"The system-generated identifier of a cost category.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetCodeId":{ "type":"integer", "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
                                                                                                                                                                                                                                                                                Calculated as Original Quantity multiplied by Original Productivity Rate.
                                                                                                                                                                                                                                                                                Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"Calculated as the sum of all pending hour changes in the change records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The sum of all approved change hours in the change and transfer records for the scope assignment.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"The Revised Hours at the time the baseline was set.", "format":"double", "exampleSetFlag":false }, "etcHours":{ "type":"number", "description":"The estimated number of hours needed to complete the work.
                                                                                                                                                                                                                                                                                Calculated as BAC Hours minus Earned Hours.", "format":"double", "exampleSetFlag":false }, "eacHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"Calculated as ETC Hours plus Actual Hours to Date.", "format":"double", "exampleSetFlag":false }, "earnedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Hours.", "format":"double", "exampleSetFlag":false }, "etcAdjustedHours":{ "type":"number", "description":"The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.", "format":"double", "exampleSetFlag":false }, "actualHoursToDate":{ "minimum":0, "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).", "format":"double", "exampleSetFlag":false }, "bacHours":{ "type":"number", "description":"The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "remainingHours":{ "type":"number", "description":"The number of hours left for the scope assignment.
                                                                                                                                                                                                                                                                                Calculated as Remaining Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false }, "installedHours":{ "maximum":1000000000, "minimum":0, "type":"number", "description":"Hours spent on the scope assignment.
                                                                                                                                                                                                                                                                                Calculated as Installed Quantity multiplied by Revised Productivity Rate.", "format":"double", "exampleSetFlag":false }, "atCompletionHours":{ "type":"number", "description":"The total hours expected for the scope assignment.
                                                                                                                                                                                                                                                                                Calculated as Revised Hours plus Adjusted Hours.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a scope item assignment.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of a work package.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ] }, "rateBy":{ "type":"string", "description":"Determines whether the cost is calculated using the Quantity or Hours.
                                                                                                                                                                                                                                                                                Quantity: Quantity is used to calculate cost. For example, Original Cost is calculated as Original Quantity times Original Cost Rate.
                                                                                                                                                                                                                                                                                Hours: Hours are used to calculate cost. For example, Original Cost is calculated as Original Hours times Original Cost Rate.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HOURS", "QUANTITY" ] }, "curve":{ "type":"integer", "description":"The curve profile selected for the scope assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a ScopeItemAssignment object, a unique ScopeItemAssignment object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                • scopeItemAssignmentId
                                                                                                                                                                                                                                                                                • scopeItemAssignmentCode,projectId,scopeItemId,workPackageId
                                                                                                                                                                                                                                                                                • scopeItemAssignmentCode,projectCode,workspaceCode,scopeItemId,workPackageId
                                                                                                                                                                                                                                                                                • scopeItemAssignmentCode,projectId,scopeItemCode,workPackageId
                                                                                                                                                                                                                                                                                • scopeItemAssignmentCode,projectId,scopeItemId,workPackageCode
                                                                                                                                                                                                                                                                                • scopeItemAssignmentCode,projectCode,workspaceCode,scopeItemId,workPackageCode
                                                                                                                                                                                                                                                                                • scopeItemAssignmentCode,projectCode,workspaceCode,scopeItemCode,workPackageId
                                                                                                                                                                                                                                                                                • scopeItemAssignmentCode,projectId,scopeItemCode,workPackageCode
                                                                                                                                                                                                                                                                                • scopeItemAssignmentCode,projectCode,workspaceCode,scopeItemCode,workPackageCode
                                                                                                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentMilestoneInput":{ "title":"ApiEntityScopeItemAssignmentMilestoneInput", "required":[ "milestone", "scopeItemAssignmentId" ], "type":"object", "properties":{ "scopeItemAssignmentMilestoneId":{ "type":"integer", "description":"Unique identifier of the scope item assignment milestone.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "milestoneProgressPercent":{ "maximum":1, "minimum":0, "type":"number", "description":"The progress percentage complete per milestone for the scope assignment. The values are used to calculate Milestone Progress Percent Complete for the scope assignment.", "format":"double", "exampleSetFlag":false }, "milestone":{ "description":"A milestone assigned to a scope assignment.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestoneInput" } ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "percentComplete":{ "maximum":1, "minimum":0, "type":"number", "description":"The user entered percentage complete for the individual milestones for the scope assignment.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentCostPeriodCloseOut":{ "title":"ApiEntityScopeItemAssignmentCostPeriodCloseOut", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "scopeAssignmentPeriodCloseOutId":{ "type":"integer", "description":"The unique identifier of scope cost data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualCostProject":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCost":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done). This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "eacCostProject":{ "type":"number", "description":"The total cost estimated to be earned as the completion of the work package. Calculated as ETC Cost plus Actual Cost to Date. This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "etcCostProject":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated as BAC Cost minus Earned Cost. This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "earnedCostProject":{ "type":"number", "description":"The portion of the budgeted cost that is currently earned for the work package. Calculated as Performance Percent Complete multiplied by BAC Cost. This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "bacCostProject":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"The total cost at the completion of the scope assignment. Calculated as Revised Cost plus Adjusted Cost. This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "installedCostProject":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date. If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours. If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This is the cumulative value for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "earnedCost":{ "type":"number", "description":"Calculated as Performance Percent Complete multiplied by BAC Cost. This field is in base currency and is calculated from earnedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "installedCost":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date. If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours. If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity. This field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The total cost at the completion of the scope assignment. Calculated as Revised Cost plus Adjusted Cost. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "etcCost":{ "type":"number", "description":"The estimate of the cost needed to complete the work. Calculated as BAC Cost minus Earned Cost. This field is in base currency and is calculated from etcCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "eacCost":{ "type":"number", "description":"Calculated as ETC Cost plus Actual Cost to Date. This field is in base currency and is calculated from eacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "bacCost":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set. This field is in base currency and is calculated from bacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentPeriodCloseOut":{ "title":"ApiEntityScopeItemAssignmentPeriodCloseOut", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "performancePercentComplete":{ "type":"number", "description":"The percentage of the activity planned work that is currently complete.", "format":"double", "exampleSetFlag":false }, "scopeItemAssignmentCostPeriodCloseOut":{ "description":"An object containing the cost fields associated with the period closeout.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityScopeItemAssignmentCostPeriodCloseOut" } ] }, "scopeAssignmentPeriodCloseOutId":{ "type":"integer", "description":"The unique identifier of scope data.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "periodItemId":{ "type":"integer", "description":"The unique identifier of a period item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualHours":{ "type":"number", "description":"Hours spent on the scope assignment. Calculated as Actual quantity to date multiplied by original install rate.", "format":"double", "exampleSetFlag":false }, "scopePercentComplete":{ "type":"number", "description":"Calculated as installed quantity divided by at completion quantity.", "format":"double", "exampleSetFlag":false }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier for a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "eacUnits":{ "type":"number", "description":"Estimate of how much material or product will be installed at completion of the scope assignment work. Calculated as ETC quantity plus actual quantity to date.", "format":"double", "exampleSetFlag":false }, "etcUnits":{ "type":"number", "description":"Estimate of quantity needed to complete the scope item. Calculated as BAC quantity minus earned quantity.", "format":"double", "exampleSetFlag":false }, "earnedUnits":{ "type":"number", "description":"Amount of material or product that has been installed based on the performance percent complete of the scope assignment and the budget at completion quantity. Calculated as performance percent complete multiplied by BAC quantity.", "format":"double", "exampleSetFlag":false }, "bacUnits":{ "type":"number", "description":"The revised quantity or at completion quantity at the time the current baseline was set, depending on the selection for the budget at completion method. The revised quantity of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "installedUnits":{ "type":"number", "description":"Amount of material or product that has been installed to date. If the progress measure on the work package is set to milestone percent complete, then installed quantity equals revised quantity multiplied by milestone progress percent complete.", "format":"double", "exampleSetFlag":false }, "actualUnits":{ "type":"number", "description":"installed quantity for the scope assignment.", "format":"double", "exampleSetFlag":false }, "atCompletionUnits":{ "type":"number", "description":"The total amount of the scope item to be installed for the scope assignment. Calculated as revised quantity plus adjusted quantity.", "format":"double", "exampleSetFlag":false }, "etcHours":{ "type":"number", "description":"Estimated number of hours needed to complete the scope item. Calculated as BAC hours minus earned hours.", "format":"double", "exampleSetFlag":false }, "eacHours":{ "type":"number", "description":"Calculated as ETC hours plus actual hours to date.", "format":"double", "exampleSetFlag":false }, "earnedHours":{ "type":"number", "description":"Calculated as performance percent complete multiplied by BAC hours.", "format":"double", "exampleSetFlag":false }, "bacHours":{ "type":"number", "description":"The revised hours or at completion hours at the time the current baseline was set, depending on the selection for the budget at completion hours. The revised hours of the current project if no baseline is set.", "format":"double", "exampleSetFlag":false }, "installedHours":{ "type":"number", "description":"Hours spent on the scope item. Calculated as installed quantity multiplied by revised productivity rate.", "format":"double", "exampleSetFlag":false }, "atCompletionHours":{ "type":"number", "description":"Total hours expected for the scope assignment. Calculated as revised hours plus adjusted hours.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSSheetSegment":{ "title":"ApiEntityCBSSheetSegment", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "copiedFrom":{ "type":"integer", "description":"The unique identifier of the CBS segment that was copied to create the one being viewed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetSegmentId":{ "type":"integer", "description":"The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costSheetId":{ "type":"integer", "description":"The system-generated identifier of a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified unique identifier of the workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "segmentDefinitionName":{ "maxLength":255, "type":"string", "description":"The name of the level of the cost breakdown structure segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "segmentDefaultValue":{ "maxLength":60, "type":"string", "description":"A value that is added to the concatenated code by default. This is not a required field.", "exampleSetFlag":false, "types":[ "string" ] }, "segmentSeparator":{ "maxLength":10, "type":"string", "description":"The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSSheetSegmentInput":{ "title":"ApiEntityCBSSheetSegmentInput", "required":[ "projectId", "segmentDefinitionName", "segmentSeparator" ], "type":"object", "properties":{ "copiedFrom":{ "type":"integer", "description":"The unique identifier of the CBS segment that was copied to create the one being viewed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsSheetSegmentId":{ "type":"integer", "description":"The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costSheetId":{ "type":"integer", "description":"The system-generated identifier of a cost sheet.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified unique identifier of the workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "segmentDefinitionName":{ "maxLength":255, "type":"string", "description":"The name of the level of the cost breakdown structure segment definition.", "exampleSetFlag":false, "types":[ "string" ] }, "segmentDefaultValue":{ "maxLength":60, "type":"string", "description":"A value that is added to the concatenated code by default. This is not a required field.", "exampleSetFlag":false, "types":[ "string" ] }, "segmentSeparator":{ "maxLength":10, "type":"string", "description":"The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a CBSSheetSegment object, a unique CBSSheetSegment object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                  • cbsSheetSegmentId
                                                                                                                                                                                                                                                                                  • segmentDefinitionName,projectId
                                                                                                                                                                                                                                                                                  • segmentDefinitionName,projectCode,workspaceCode
                                                                                                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityCBSTemplateSegment":{ "title":"ApiEntityCBSTemplateSegment", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "copiedFrom":{ "type":"integer", "description":"The unique identifier of the CBS segment that was copied to create the one being viewed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified unique identifier of the workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsTemplateSegmentId":{ "type":"integer", "description":"The unique identifier for the CBS segment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "segmentDefinitionName":{ "maxLength":255, "type":"string", "description":"The name of the CBS segment.", "exampleSetFlag":false, "types":[ "string" ] }, "segmentDefaultValue":{ "maxLength":60, "type":"string", "description":"A value that is added to the concatenated code by default. This is not a required field.", "exampleSetFlag":false, "types":[ "string" ] }, "segmentSeparator":{ "maxLength":10, "type":"string", "description":"The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen.", "exampleSetFlag":false, "types":[ "string" ] }, "templateId":{ "type":"integer", "description":"The unique identifier for the CBS template.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCBSTemplateSegmentInput":{ "title":"ApiEntityCBSTemplateSegmentInput", "required":[ "segmentDefinitionName", "segmentSeparator", "workspaceId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "copiedFrom":{ "type":"integer", "description":"The unique identifier of the CBS segment that was copied to create the one being viewed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified unique identifier of the workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "cbsTemplateSegmentId":{ "type":"integer", "description":"The unique identifier for the CBS segment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "segmentDefinitionName":{ "maxLength":255, "type":"string", "description":"The name of the CBS segment.", "exampleSetFlag":false, "types":[ "string" ] }, "segmentDefaultValue":{ "maxLength":60, "type":"string", "description":"A value that is added to the concatenated code by default. This is not a required field.", "exampleSetFlag":false, "types":[ "string" ] }, "segmentSeparator":{ "maxLength":10, "type":"string", "description":"The separator determines how the concatenated code is separated. The separator can be a period, space, or hyphen.", "exampleSetFlag":false, "types":[ "string" ] }, "templateId":{ "type":"integer", "description":"The unique identifier for the CBS template.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a CBSTemplateSegment object, a unique CBSTemplateSegment object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                    • cbsTemplateSegmentId
                                                                                                                                                                                                                                                                                    • segmentDefinitionName,workspaceId
                                                                                                                                                                                                                                                                                    • segmentDefinitionName,workspaceCode
                                                                                                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityCalcActivitySpreadInput":{ "title":"ApiEntityCalcActivitySpreadInput", "required":[ "projectId" ], "type":"object", "properties":{ "timescale":{ "type":"string", "description":"Timescale for the spread calculation. If not provided, Daily will be used.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY" ] }, "activityIds":{ "type":"array", "description":"The list of IDs for the activities used in the spread calculations. If not provided, all activities in the project will be used in the spread calculations.", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "activitySpreadItems":{ "type":"array", "description":"An array of activity spread items. If not provided, the default set Planned/Actual/Remaining/At Completion Labor Units/Total Cost will be used.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "plannedLaborUnits", "plannedNonlaborUnits", "plannedLaborCost", "plannedNonlaborCost", "plannedMaterialCost", "plannedTotalCost", "actualLaborUnits", "actualNonlaborUnits", "actualLaborCost", "actualNonlaborCost", "actualMaterialCost", "actualTotalCost", "remainingLaborUnits", "remainingNonlaborUnits", "remainingLaborCost", "remainingNonlaborCost", "remainingMaterialCost", "remainingTotalCost", "atCompletionLaborUnits", "atCompletionNonlaborUnits", "atCompletionLaborCost", "atCompletionNonlaborCost", "atCompletionMaterialCost", "atCompletionTotalCost", "remainingLateLaborUnits", "remainingLateNonlaborUnits", "remainingLateLaborCost", "remainingLateNonlaborCost", "remainingLateMaterialCost", "remainingLateTotalCost", "earnedValueLaborUnits", "earnedValueCost", "plannedValueLaborUnits", "plannedValueCost", "estimateToCompleteLaborUnits", "estimateToCompleteCost", "estimateAtCompletionLaborUnits", "estimateAtCompletionCost" ] }, "types":[ "array" ] }, "isBaseline":{ "type":"boolean", "description":"Indicates whether or not the spread calculation is for Earned Value baseline.", "exampleSetFlag":false, "types":[ "boolean" ] }, "cutoffDate":{ "type":"string", "description":"Cutoff date for the spread calculations. Populate if you want to cease the calculation of spreads beyond a specified date to speed up the processing of the job. Any values remaining after the cutoff date will be added as a lump sum in the cutoff date bucket. If not provided, all spreads with be calculated for the duration of the activity/assignment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCalcAssignmentSpreadInput":{ "title":"ApiEntityCalcAssignmentSpreadInput", "type":"object", "properties":{ "timescale":{ "type":"string", "description":"Timescale for the spread calculation. If not provided, Daily will be used.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY" ] }, "isBaseline":{ "type":"boolean", "description":"Indicates whether or not the spread calculation is for Earned Value baseline.", "exampleSetFlag":false, "types":[ "boolean" ] }, "cutoffDate":{ "type":"string", "description":"Cutoff date for the spread calculations. Populate if you want to cease the calculation of spreads beyond a specified date to speed up the processing of the job. Any values remaining after the cutoff date will be added as a lump sum in the cutoff date bucket. If not provided, all spreads with be calculated for the duration of the activity/assignment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "assignmentIds":{ "type":"array", "description":"The list of IDs for the assignments used in the spread calculations. If not provided, all assignments in the project will be used in the spread calculations.", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "assignmentSpreadItems":{ "type":"array", "description":"An array of assignment spread items. If not provided, the default set Planned/Actual/Remaining/At Completion Units/Cost will be used.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "plannedUnits", "plannedCost", "actualUnits", "actualCost", "remainingUnits", "remainingCost", "atCompletionUnits", "atCompletionCost", "remainingLateUnits", "remainingLateCost" ] }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntitySpreadOutput":{ "title":"ApiEntitySpreadOutput", "type":"object", "properties":{ "timescale":{ "type":"string", "description":"Timescale for the spread calculation. If not provided, Daily will be used.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY" ] }, "activities":{ "type":"array", "description":"The aggregate that contains the list of activities used in the spread calculation. It is applicable when downloading the spread output for Calculate Activity Spread jobs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySpreadOutputActivity", "exampleSetFlag":false }, "types":[ "array" ] }, "resourceAssignments":{ "type":"array", "description":"The aggregate that contains the list of resource assignments used in the spread calculation. It is applicable when downloading the spread output for Calculate Assignment Spread jobs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntitySpreadOutputAssignment", "exampleSetFlag":false }, "types":[ "array" ] }, "cutoffDate":{ "type":"string", "description":"Cutoff date for the spread calculations. Populate if you want to cease the calculation of spreads beyond a specified date to speed up the processing of the job. Any values remaining after the cutoff date will be added as a lump sum in the cutoff date bucket. If not provided, all spreads with be calculated for the duration of the activity/assignment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "project":{ "description":"The aggregate that contains key information about the project used in the spread calculation.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntitySpreadOutputProject" } ] } }, "exampleSetFlag":false }, "ApiEntitySpreadOutputActivity":{ "title":"ApiEntitySpreadOutputActivity", "type":"object", "properties":{ "estimateAtCompletionLaborUnits":{ "type":"number", "description":"The estimated labor units at completion.
                                                                                                                                                                                                                                                                                      Calculated as Actual Labor Units plus Estimate To Complete Labor Units. Estimate To Complete Labor Units is calculated based off of the Earned Value setting.", "format":"double", "exampleSetFlag":false }, "estimateAtCompletionCost":{ "type":"number", "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateAtCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionMaterialCost":{ "type":"number", "description":"The sum of the actual and remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from atCompletionMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualMaterialCostProject":{ "type":"number", "description":"The actual cost for all material resources assigned to the activity. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "atCompletionLaborCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all labor resource assignments on the activity. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "atCompletionMaterialCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all material resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionTotalCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedMaterialCostProject":{ "type":"number", "description":"The planned cost for all material resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingLaborCostProject":{ "type":"number", "description":"The remaining cost for all labor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingMaterialCostProject":{ "type":"number", "description":"The remaining cost for all material resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingTotalCostProject":{ "type":"number", "description":"The remaining cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "estimateAtCompletionCostProject":{ "type":"number", "description":"The forecasted cost of the project as the project progresses. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionNonlaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all nonlabor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      It is the same as the planned nonlabor units if the activity is not started, and the actual nonlabor units after the activity is completed.
                                                                                                                                                                                                                                                                                      Calculated as Actual Nonlabor Units plus Remaining Nonlabor Units.", "format":"double", "exampleSetFlag":false }, "remainingLateNonlaborUnits":{ "type":"number", "description":"The remaining units for all nonlabor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      The remaining units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, there are zero remaining units.", "format":"double", "exampleSetFlag":false }, "estimateToCompleteLaborUnits":{ "type":"number", "description":"The estimated number of labor units required to complete the activity.
                                                                                                                                                                                                                                                                                      Calculated as the Remaining Total Units for the activity.", "format":"double", "exampleSetFlag":false }, "atCompletionNonlaborCost":{ "type":"number", "description":"The sum of the actual and remaining costs for all non-labor resource assigned to the activity. This field is in base currency and is calculated from atCompletionNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingLateNonlaborCost":{ "type":"number", "description":"The remaining late cost for all nonlabor resource assignments on the activity. This field is in base currency and is calculated from remainingLateNonlaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingLateMaterialCost":{ "type":"number", "description":"The remaining late cost for all material resource assignments on the activity. This field is in base currency and is calculated from remainingLateMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedNonlaborCostProject":{ "type":"number", "description":"The planned cost for all nonlabor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualNonlaborCostProject":{ "type":"number", "description":"The actual costs for all nonlabor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingNonlaborCostProject":{ "type":"number", "description":"The remaining cost for all nonlabor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionNonlaborCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all nonlabor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingLateLaborCostProject":{ "type":"number", "description":"The remaining late cost for all labor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingLateNonlaborCostProject":{ "type":"number", "description":"The remaining late cost for all nonlabor resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingLateMaterialCostProject":{ "type":"number", "description":"The remaining late cost for all material resource assignments on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingLateTotalCostProject":{ "type":"number", "description":"The remaining late cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "estimateToCompleteCostProject":{ "type":"number", "description":"The estimated cost to complete the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedNonlaborUnits":{ "type":"number", "description":"The planned units for all nonlabor resources assigned to the activities in the project.", "format":"double", "exampleSetFlag":false }, "actualNonlaborUnits":{ "type":"number", "description":"The number of nonlabor units that have been expended on the activity.", "format":"double", "exampleSetFlag":false }, "remainingNonlaborUnits":{ "type":"number", "description":"The remaining units for all nonlabor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      The remaining units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, there are zero remaining units.", "format":"double", "exampleSetFlag":false }, "remainingLateLaborUnits":{ "type":"number", "description":"The remaining units for all labor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      The Remaining Labor Units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.", "format":"double", "exampleSetFlag":false }, "plannedNonlaborCost":{ "type":"number", "description":"The planned costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from plannedNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualNonlaborCost":{ "type":"number", "description":"The actual costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from actualNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingNonlaborCost":{ "type":"number", "description":"The remaining costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from remainingNonLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingLateLaborCost":{ "type":"number", "description":"The remaining late cost for all labor resource assignments on the activity. This field is in base currency and is calculated from remainingLateLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingLateTotalCost":{ "type":"number", "description":"The remaining late cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingLateTotalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "estimateToCompleteCost":{ "type":"number", "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateToCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedValueCostProject":{ "type":"number", "description":"The approved budget for work actually completed by the specified project data date.
                                                                                                                                                                                                                                                                                      Calculated as Budget At Completion multiplied by Performance Percent Complete. The method for computing performance percent complete depends on the Earned Value technique defined in the project settings. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedValueCostProject":{ "type":"number", "description":"The approved budget for the work scheduled to be completed by a specified date.
                                                                                                                                                                                                                                                                                      Calculated as Budget At Completion multiplied by Schedule Percent Complete.
                                                                                                                                                                                                                                                                                      When an activity has assignments, the Planned Value Cost is calculated as Budget At Completion multiplied by (Data Date of Current Project - Baseline Assignment Start Date) divided by (Baseline Assignment Finish Date - Baseline Assignment Start Date). Each assignment is then summed to the activity-level planned value. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionLaborUnits":{ "type":"number", "description":"The sum of the actual plus remaining units for all labor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      It is the same as the planned labor units if the activity is not started, and the actual labor units after the activity is completed.
                                                                                                                                                                                                                                                                                      Calculated as Actual Labor Units plus Remaining Labor Units.", "format":"double", "exampleSetFlag":false }, "plannedLaborUnits":{ "type":"number", "description":"The planned number of units for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "remainingLaborUnits":{ "type":"number", "description":"The remaining units for all labor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      The Remaining Labor Units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.", "format":"double", "exampleSetFlag":false }, "actualLaborUnits":{ "type":"number", "description":"The number of units expended for all labor resources assigned to the activity.", "format":"double", "exampleSetFlag":false }, "earnedValueLaborUnits":{ "type":"number", "description":"The portion of baseline labor units that are actually completed as of the project data date.
                                                                                                                                                                                                                                                                                      Calculated as Budget At Completion Labor Units multiplied by Performance Percent Complete. The performance percent complete will be calculated using the activity percent complete.", "format":"double", "exampleSetFlag":false }, "plannedValueCost":{ "type":"number", "description":"The portion of the baseline total cost of the activity that is scheduled to be completed as of the project data date. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedValueLaborUnits":{ "type":"number", "description":"The portion of baseline labor units that are scheduled to be completed as of the project data date.
                                                                                                                                                                                                                                                                                      Calculated as Budget At Completion Labor Units multiplied by Schedule Percent Complete.", "format":"double", "exampleSetFlag":false }, "earnedValueCost":{ "type":"number", "description":"The portion of the baseline total cost of the activity that is actually completed as of the project data date. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionLaborCost":{ "type":"number", "description":"The sum of the actual and remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from atCompletionLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingLaborCost":{ "type":"number", "description":"The remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from remainingLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualTotalCost":{ "type":"number", "description":"The actual total cost for all resource assignments and direct activity costs (expenses) on the activity.", "format":"double", "exampleSetFlag":false }, "remainingMaterialCost":{ "type":"number", "description":"The remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from remainingMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedLaborCost":{ "type":"number", "description":"The planned costs for all labor resources assigned to the activity. This field is in base currency and is calculated from plannedLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingTotalCost":{ "type":"number", "description":"The remaining cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingTotalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionTotalCost":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from atCompletionTotalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedMaterialCost":{ "type":"number", "description":"The planned costs for all material resources assigned to the activity. This field is in base currency and is calculated from plannedMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualLaborCost":{ "type":"number", "description":"The actual costs for all labor resources assigned to the activity. This field is in base currency and is calculated from actualLaborCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualMaterialCost":{ "type":"number", "description":"The actual cost for all material resources assigned to the activity. This field is in base currency and is calculated from actualMaterialCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "plannedTotalCost":{ "type":"number", "description":"The expected total cost of the activity and includes all resources and direct activity costs (expenses). This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualLaborCostProject":{ "type":"number", "description":"The actual costs for all labor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualTotalCostProject":{ "type":"number", "description":"The actual total cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "plannedLaborCostProject":{ "type":"number", "description":"The planned cost for all labor resources assigned to the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedTotalCostProject":{ "type":"number", "description":"The expected total cost of the activity, including all resource assignments and direct activity costs. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "activityName":{ "maxLength":255, "type":"string", "description":"The name of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "wbsId":{ "type":"integer", "description":"The WBS that the activity is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "spread":{ "description":"The aggregate that contains the lists of spread dates and spread values for the activity spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate is applicable when downloading the spread output for Calculate Activity Spread jobs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntitySpreadOutputActivitySpread" } ] } }, "exampleSetFlag":false }, "ApiEntitySpreadOutputActivitySpread":{ "title":"ApiEntitySpreadOutputActivitySpread", "type":"object", "properties":{ "estimateAtCompletionLaborUnits":{ "type":"array", "description":"The estimated labor units at completion.
                                                                                                                                                                                                                                                                                      Calculated as Actual Labor Units plus Estimate To Complete Labor Units. Estimate To Complete Labor Units is calculated based off of the Earned Value setting.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "estimateAtCompletionCost":{ "type":"array", "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateAtCompletionCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionMaterialCost":{ "type":"array", "description":"The sum of the actual and remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from atCompletionMaterialCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualMaterialCostProject":{ "type":"array", "description":"The actual cost for all material resources assigned to the activity. This value is based on the project currency. ", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionLaborCostProject":{ "type":"array", "description":"The sum of the actual costs plus remaining costs for all labor resource assignments on the activity. This value is based on the project currency. ", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionMaterialCostProject":{ "type":"array", "description":"The sum of the actual costs plus remaining costs for all material resource assignments on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionTotalCostProject":{ "type":"array", "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedMaterialCostProject":{ "type":"array", "description":"The planned cost for all material resources assigned to the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLaborCostProject":{ "type":"array", "description":"The remaining cost for all labor resource assignments on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingMaterialCostProject":{ "type":"array", "description":"The remaining cost for all material resource assignments on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingTotalCostProject":{ "type":"array", "description":"The remaining cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "estimateAtCompletionCostProject":{ "type":"array", "description":"The forecasted cost of the project as the project progresses. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionNonlaborUnits":{ "type":"array", "description":"The sum of the actual plus remaining units for all nonlabor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      It is the same as the planned nonlabor units if the activity is not started, and the actual nonlabor units after the activity is completed.
                                                                                                                                                                                                                                                                                      Calculated as Actual Nonlabor Units plus Remaining Nonlabor Units.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateNonlaborUnits":{ "type":"array", "description":"The remaining units for all nonlabor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      The remaining units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, there are zero remaining units.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "estimateToCompleteLaborUnits":{ "type":"array", "description":"The estimated number of labor units required to complete the activity.
                                                                                                                                                                                                                                                                                      Calculated as the Remaining Total Units for the activity.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionNonlaborCost":{ "type":"array", "description":"The sum of the actual and remaining costs for all non-labor resource assigned to the activity. This field is in base currency and is calculated from atCompletionNonLaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateNonlaborCost":{ "type":"array", "description":"The remaining late cost for all nonlabor resource assignments on the activity. This field is in base currency and is calculated from remainingLateNonlaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateMaterialCost":{ "type":"array", "description":"The remaining late cost for all material resource assignments on the activity. This field is in base currency and is calculated from remainingLateMaterialCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedNonlaborCostProject":{ "type":"array", "description":"The planned cost for all nonlabor resources assigned to the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualNonlaborCostProject":{ "type":"array", "description":"The actual costs for all nonlabor resources assigned to the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingNonlaborCostProject":{ "type":"array", "description":"The remaining cost for all nonlabor resource assignments on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionNonlaborCostProject":{ "type":"array", "description":"The sum of the actual costs plus remaining costs for all nonlabor resource assignments on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateLaborCostProject":{ "type":"array", "description":"The remaining late cost for all labor resource assignments on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateNonlaborCostProject":{ "type":"array", "description":"The remaining late cost for all nonlabor resource assignments on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateMaterialCostProject":{ "type":"array", "description":"The remaining late cost for all material resource assignments on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateTotalCostProject":{ "type":"array", "description":"The remaining late cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "estimateToCompleteCostProject":{ "type":"array", "description":"The estimated cost to complete the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedNonlaborUnits":{ "type":"array", "description":"The planned units for all nonlabor resources assigned to the activities in the project.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualNonlaborUnits":{ "type":"array", "description":"The number of nonlabor units that have been expended on the activity.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingNonlaborUnits":{ "type":"array", "description":"The remaining units for all nonlabor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      The remaining units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, there are zero remaining units.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateLaborUnits":{ "type":"array", "description":"The remaining units for all labor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      The Remaining Labor Units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedNonlaborCost":{ "type":"array", "description":"The planned costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from plannedNonLaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualNonlaborCost":{ "type":"array", "description":"The actual costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from actualNonLaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingNonlaborCost":{ "type":"array", "description":"The remaining costs for all nonlabor resources assigned to the activity. This field is in base currency and is calculated from remainingNonLaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateLaborCost":{ "type":"array", "description":"The remaining late cost for all labor resource assignments on the activity. This field is in base currency and is calculated from remainingLateLaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateTotalCost":{ "type":"array", "description":"The remaining late cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingLateTotalCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "estimateToCompleteCost":{ "type":"array", "description":"Calculated as estimate to completion cost plus Actual Cost to Date. This field is in base currency and is calculated from estimateToCompletionCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "spreadDates":{ "type":"array", "description":"The list of spread dates derived according to the timescale for all the spread items in the request.", "exampleSetFlag":false, "items":{ "type":"string", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "earnedValueCostProject":{ "type":"array", "description":"The approved budget for work actually completed by the specified project data date.
                                                                                                                                                                                                                                                                                      Calculated as Budget At Completion multiplied by Performance Percent Complete. The method for computing performance percent complete depends on the Earned Value technique defined in the project settings. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedValueCostProject":{ "type":"array", "description":"The approved budget for the work scheduled to be completed by a specified date.
                                                                                                                                                                                                                                                                                      Calculated as Budget At Completion multiplied by Schedule Percent Complete.
                                                                                                                                                                                                                                                                                      When an activity has assignments, the Planned Value Cost is calculated as Budget At Completion multiplied by (Data Date of Current Project - Baseline Assignment Start Date) divided by (Baseline Assignment Finish Date - Baseline Assignment Start Date). Each assignment is then summed to the activity-level planned value. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionLaborUnits":{ "type":"array", "description":"The sum of the actual plus remaining units for all labor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      It is the same as the planned labor units if the activity is not started, and the actual labor units after the activity is completed.
                                                                                                                                                                                                                                                                                      Calculated as Actual Labor Units plus Remaining Labor Units.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedLaborUnits":{ "type":"array", "description":"The planned number of units for all labor resources assigned to the activity.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLaborUnits":{ "type":"array", "description":"The remaining units for all labor resources assigned to the activity.
                                                                                                                                                                                                                                                                                      The Remaining Labor Units reflect the work remaining to be done for the activity. Before the activity is started, the remaining units are the same as the planned units. After the activity is completed, the remaining units are zero.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualLaborUnits":{ "type":"array", "description":"The number of units expended for all labor resources assigned to the activity.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "earnedValueLaborUnits":{ "type":"array", "description":"The portion of baseline labor units that are actually completed as of the project data date.
                                                                                                                                                                                                                                                                                      Calculated as Budget At Completion Labor Units multiplied by Performance Percent Complete. The performance percent complete will be calculated using the activity percent complete.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedValueCost":{ "type":"array", "description":"The portion of the baseline total cost of the activity that is scheduled to be completed as of the project data date. This field is in base currency and is calculated from plannedValueCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedValueLaborUnits":{ "type":"array", "description":"The portion of baseline labor units that are scheduled to be completed as of the project data date.
                                                                                                                                                                                                                                                                                      Calculated as Budget At Completion Labor Units multiplied by Schedule Percent Complete.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "earnedValueCost":{ "type":"array", "description":"The portion of the baseline total cost of the activity that is actually completed as of the project data date. This field is in base currency and is calculated from earnedValueCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionLaborCost":{ "type":"array", "description":"The sum of the actual and remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from atCompletionLaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLaborCost":{ "type":"array", "description":"The remaining costs for all labor resources assigned to the activity. This field is in base currency and is calculated from remainingLaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualTotalCost":{ "type":"array", "description":"The actual total cost for all resource assignments and direct activity costs (expenses) on the activity.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingMaterialCost":{ "type":"array", "description":"The remaining costs for all material resources assigned to the activity. This field is in base currency and is calculated from remainingMaterialCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedLaborCost":{ "type":"array", "description":"The planned costs for all labor resources assigned to the activity. This field is in base currency and is calculated from plannedLaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingTotalCost":{ "type":"array", "description":"The remaining cost for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from remainingTotalCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionTotalCost":{ "type":"array", "description":"The sum of the actual costs plus remaining costs for all resource assignments and direct activity costs (expenses) on the activity. This field is in base currency and is calculated from atCompletionTotalCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedMaterialCost":{ "type":"array", "description":"The planned costs for all material resources assigned to the activity. This field is in base currency and is calculated from plannedMaterialCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualLaborCost":{ "type":"array", "description":"The actual costs for all labor resources assigned to the activity. This field is in base currency and is calculated from actualLaborCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualMaterialCost":{ "type":"array", "description":"The actual cost for all material resources assigned to the activity. This field is in base currency and is calculated from actualMaterialCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedTotalCost":{ "type":"array", "description":"The expected total cost of the activity and includes all resources and direct activity costs (expenses). This field is in base currency and is calculated from plannedTotalCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualLaborCostProject":{ "type":"array", "description":"The actual costs for all labor resources assigned to the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualTotalCostProject":{ "type":"array", "description":"The actual total cost for all resource assignments and direct activity costs on the activity. This value is based on the project currency. ", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedLaborCostProject":{ "type":"array", "description":"The planned cost for all labor resources assigned to the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedTotalCostProject":{ "type":"array", "description":"The expected total cost of the activity, including all resource assignments and direct activity costs. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntitySpreadOutputAssignment":{ "title":"ApiEntitySpreadOutputAssignment", "type":"object", "properties":{ "remainingLateCostProject":{ "type":"number", "description":"The remaining late cost for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingLateUnits":{ "type":"number", "description":"The remaining units of work to be performed by the resource on the activity.", "format":"double", "exampleSetFlag":false }, "remainingLateCost":{ "type":"number", "description":"The remaining late cost for the activity resource assignment. This field is in base currency and is calculated from remainingLateCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "rateSource":{ "type":"string", "description":"The value that indicates which Price/Unit will be used to calculate costs for the assignment. Valid options are Resource, Role, or Override.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "RESOURCE", "ROLE", "OVERRIDE" ] }, "actualCostProject":{ "type":"number", "description":"The actual cost for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCost":{ "type":"number", "description":"The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "roleCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "roleName":{ "maxLength":255, "type":"string", "description":"The name of the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedCostProject":{ "type":"number", "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingCostProject":{ "type":"number", "description":"The remaining cost for the resource assignment on the activity. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "assignmentId":{ "type":"integer", "description":"The system-generated identifier of an assignment.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "assignmentCode":{ "maxLength":60, "type":"string", "description":"A unique identifier for the assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "actualUnits":{ "type":"number", "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.", "format":"double", "exampleSetFlag":false }, "plannedUnits":{ "type":"number", "description":"The planned units of work for the resource assignment on the activity.", "format":"double", "exampleSetFlag":false }, "atCompletionUnits":{ "type":"number", "description":"The sum of the actual units and remaining units for the resource assignment on the activity.
                                                                                                                                                                                                                                                                                      Calculated as Actual Units plus Remaining Units.", "format":"double", "exampleSetFlag":false }, "remainingUnits":{ "type":"number", "description":"The remaining units of work to be performed by the resource on the activity.", "format":"double", "exampleSetFlag":false }, "resourceId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "resourceCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "resourceName":{ "maxLength":255, "type":"string", "description":"The name of the resource or role.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The unique identifier for the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "activityCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "activityName":{ "maxLength":255, "type":"string", "description":"The name of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedCost":{ "type":"number", "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "roleId":{ "type":"integer", "description":"The unique identifier for the resource or role.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "spread":{ "description":"The aggregate that contains the lists of spread dates and spread values for the assignment spread items in the request. The spread values and dates are correlated by the indices in the lists. This aggregate applicable when downloading the spread output for Calculate Assignment Spread jobs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntitySpreadOutputAssignmentSpread" } ] } }, "exampleSetFlag":false }, "ApiEntitySpreadOutputAssignmentSpread":{ "title":"ApiEntitySpreadOutputAssignmentSpread", "type":"object", "properties":{ "remainingLateCostProject":{ "type":"array", "description":"The remaining late cost for the resource assignment on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "spreadDates":{ "type":"array", "description":"The list of spread dates derived according to the timescale for all the spread items in the request.", "exampleSetFlag":false, "items":{ "type":"string", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "remainingLateUnits":{ "type":"array", "description":"The remaining units of work to be performed by the resource on the activity.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingLateCost":{ "type":"array", "description":"The remaining late cost for the activity resource assignment. This field is in base currency and is calculated from remainingLateCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualCostProject":{ "type":"array", "description":"The actual cost for the resource assignment on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualCost":{ "type":"array", "description":"The actual cost for the resource assignment on the activity. This field is in base currency and is calculated from actualCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedCostProject":{ "type":"array", "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionCostProject":{ "type":"array", "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingCostProject":{ "type":"array", "description":"The remaining cost for the resource assignment on the activity. This value is based on the project currency.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "actualUnits":{ "type":"array", "description":"The sum of the actual non-overtime and the overtime units worked by the resource on the activity.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedUnits":{ "type":"array", "description":"The planned units of work for the resource assignment on the activity.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionUnits":{ "type":"array", "description":"The sum of the actual units and remaining units for the resource assignment on the activity.
                                                                                                                                                                                                                                                                                      Calculated as Actual Units plus Remaining Units.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingUnits":{ "type":"array", "description":"The remaining units of work to be performed by the resource on the activity.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "plannedCost":{ "type":"array", "description":"The expected total cost of the item, such as an assignment, expense, or response plan. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "remainingCost":{ "type":"array", "description":"The remaining cost for the activity resource assignment. Calculated as Remaining Units multiplied by Cost/Time. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] }, "atCompletionCost":{ "type":"array", "description":"The sum of the actual costs plus remaining costs for the resource assignment on the activity. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.", "exampleSetFlag":false, "items":{ "type":"number", "format":"double", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntitySpreadOutputProject":{ "title":"ApiEntitySpreadOutputProject", "type":"object", "properties":{ "isBaseline":{ "type":"boolean", "description":"Indicates whether or not the spread calculation is for Earned Value baseline.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectName":{ "maxLength":255, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "baselineId":{ "type":"integer", "description":"The system-generated identifier of a baseline.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "baselineName":{ "maxLength":255, "type":"string", "description":"Name for the baseline or snapshot.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueStrategy":{ "title":"ApiEntityCodeValueStrategy", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueStrategyId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityStrategy":{ "title":"ApiEntityStrategy", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyTypeId":{ "type":"integer", "description":"The system-generated identifier of the level of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyName":{ "maxLength":255, "type":"string", "description":"The name of a strategy.", "exampleSetFlag":false, "types":[ "string" ] }, "parentStrategyId":{ "type":"integer", "description":"The system-generated identifier of the parent strategy of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "weightPct":{ "type":"number", "description":"The weight or relative rank of the strategy node compared to its siblings. The value indicates the percentage that the strategy node is contributing to the parent strategy. The weight percentage for all sibling strategy nodes totals 100.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "codeValuesStrategy":{ "type":"array", "description":"The list of code values for a strategy. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueStrategy", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "type":"string", "description":"A detailed description of a strategy.", "exampleSetFlag":false, "types":[ "string" ] }, "securityGuid":{ "maxLength":32, "type":"string", "description":"The globally unique identifier of the strategy.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a strategy.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the strategy.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "weight":{ "type":"number", "description":"The relative weight of the sibling strategy node to indicate the contribution of a given node to its parent strategy node.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "ownerId":{ "type":"integer", "description":"The system-generated identifier of the user responsible for executing the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "seqNum":{ "type":"integer", "description":"The sequence number of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityStrategyConfiguredFieldValue":{ "title":"ApiEntityStrategyConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueStrategyInput":{ "title":"ApiEntityCodeValueStrategyInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "strategyId":{ "type":"integer", "description":"The system-generated identifier of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueStrategyId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueStrategy object, a unique CodeValueStrategy object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                      • codeValueStrategyId
                                                                                                                                                                                                                                                                                      • codeTypeId,codeValueCode
                                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode
                                                                                                                                                                                                                                                                                      • codeValueId
                                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode,parentId
                                                                                                                                                                                                                                                                                      • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityStrategyConfiguredFieldValueInput":{ "title":"ApiEntityStrategyConfiguredFieldValueInput", "type":"object", "properties":{ "strategyId":{ "type":"integer", "description":"The system-generated identifier of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a StrategyConfiguredFieldValue object, a unique StrategyConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                        • columnDefinitionId
                                                                                                                                                                                                                                                                                        • columnName
                                                                                                                                                                                                                                                                                        • columnLabel
                                                                                                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityStrategyInput":{ "title":"ApiEntityStrategyInput", "required":[ "ownerId", "status", "strategyName", "strategyTypeId", "weightPct", "workspaceId" ], "type":"object", "properties":{ "strategyId":{ "type":"integer", "description":"The system-generated identifier of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyTypeId":{ "type":"integer", "description":"The system-generated identifier of the level of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyName":{ "maxLength":255, "type":"string", "description":"The name of a strategy.", "exampleSetFlag":false, "types":[ "string" ] }, "parentStrategyId":{ "type":"integer", "description":"The system-generated identifier of the parent strategy of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "weightPct":{ "type":"number", "description":"The weight or relative rank of the strategy node compared to its siblings. The value indicates the percentage that the strategy node is contributing to the parent strategy. The weight percentage for all sibling strategy nodes totals 100.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "codeValuesStrategy":{ "type":"array", "description":"The list of code values for a strategy. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueStrategyInput", "exampleSetFlag":false }, "types":[ "array" ] }, "description":{ "maxLength":4000, "type":"string", "description":"A detailed description of a strategy.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a strategy.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the strategy.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "weight":{ "type":"number", "description":"The relative weight of the sibling strategy node to indicate the contribution of a given node to its parent strategy node.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "ownerId":{ "type":"integer", "description":"The system-generated identifier of the user responsible for executing the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "seqNum":{ "type":"integer", "description":"The sequence number of the strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a Strategy object, a unique Strategy object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                          • strategyId
                                                                                                                                                                                                                                                                                          • strategyName,workspaceId
                                                                                                                                                                                                                                                                                          • strategyName,workspaceCode
                                                                                                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityStrategyMeasureResponse":{ "title":"ApiEntityStrategyMeasureResponse", "type":"object", "properties":{ "strategy":{ "description":"A strategy object.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityStrategy" } ] }, "measureValues":{ "type":"array", "description":"The value of a measure.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityStrategyMeasureValue", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityStrategyMeasureValue":{ "title":"ApiEntityStrategyMeasureValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "strategyMeasureValueId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "lastCalcDate":{ "type":"string", "description":"The date on which the value was last calculated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "actualExprValue":{ "type":"number", "description":"The actual value of an expression.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "varExprValue":{ "type":"number", "description":"The variance of an expression value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "varDerivedValue":{ "type":"number", "description":"The variance of a derived value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "varBaseValue":{ "type":"number", "description":"The variance of a base value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualDerivedValue":{ "type":"number", "description":"The actual value for the measure.
                                                                                                                                                                                                                                                                                            If the measure is set manually, the current period's actual value displays.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetBaseValue":{ "type":"number", "description":"The target base value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "entryType":{ "type":"string", "description":"The type of the strategy entry.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COMPUTE" ] }, "targetDerivedValue":{ "type":"number", "description":"The target value for the measure.
                                                                                                                                                                                                                                                                                            If the measure is set manually, the current period's target value displays.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetExpressionValue":{ "type":"number", "description":"The target value of an expression.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualBaseValue":{ "type":"number", "description":"The actual base value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "measureId":{ "type":"integer", "description":"The system-generated identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityStrategyMeasure":{ "title":"ApiEntityStrategyMeasure", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "strategyMeasureId":{ "type":"integer", "description":"The system-generated identifier of a strategy measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "lastCalculatedDate":{ "type":"string", "description":"The date on which the strategy measure was last calculated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The system-generated identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "enabledFlag":{ "type":"boolean", "description":"Indicates whether the strategy measure is enabled.", "exampleSetFlag":false, "types":[ "boolean" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityStrategyMeasureInput":{ "title":"ApiEntityStrategyMeasureInput", "required":[ "measureId", "strategyId" ], "type":"object", "properties":{ "strategyMeasureId":{ "type":"integer", "description":"The system-generated identifier of a strategy measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureId":{ "type":"integer", "description":"The system-generated identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "enabledFlag":{ "type":"boolean", "description":"Indicates whether the strategy measure is enabled.", "exampleSetFlag":false, "types":[ "boolean" ] } }, "description":"This entity represents a StrategyMeasure object, a unique StrategyMeasure object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                            • strategyMeasureId
                                                                                                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityStrategyMeasureValueXReference":{ "title":"ApiEntityStrategyMeasureValueXReference", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "strategyMeasureManualValueId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "targetValue":{ "type":"number", "description":"The target value of a strategy.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualValue":{ "type":"number", "description":"The actual value of a strategy.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "beginDate":{ "type":"string", "description":"The start date of a strategy.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The system-generated identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "endDate":{ "type":"string", "description":"The end date of a strategy.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityStrategyMeasureValueXReferenceInput":{ "title":"ApiEntityStrategyMeasureValueXReferenceInput", "required":[ "beginDate", "endDate", "measureId", "strategyId" ], "type":"object", "properties":{ "strategyMeasureManualValueId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "targetValue":{ "type":"number", "description":"The target value of a strategy.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualValue":{ "type":"number", "description":"The actual value of a strategy.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "beginDate":{ "type":"string", "description":"The start date of a strategy.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The system-generated identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "endDate":{ "type":"string", "description":"The end date of a strategy.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a StrategyMeasureValueXReference object, a unique StrategyMeasureValueXReference object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                              • strategyMeasureManualValueId
                                                                                                                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityMeasureSpreadItem":{ "title":"ApiEntityMeasureSpreadItem", "type":"object", "properties":{ "start":{ "type":"string", "description":"The start date time for the earliest strategy measure's actual/target value present in the system.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "masterId":{ "type":"integer", "description":"The strategy measure ID for the spread of measure data to be retrieved.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "end":{ "type":"string", "description":"The end date time for the last strategy measure's actual/target value present in the system.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "periods":{ "type":"array", "description":"A list of all the measure spread periods that exist based on the default tracking frequency and the start and end of strategy measure values present in the system.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureSpreadPeriod", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityMeasureSpreadPeriod":{ "title":"ApiEntityMeasureSpreadPeriod", "type":"object", "properties":{ "start":{ "type":"string", "description":"The start date time for the strategy measure value.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "bucketId":{ "type":"string", "description":"Bucket ID indicates the start date time for the strategy measure value.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "statusIndicatorColor":{ "type":"string", "description":"The color for the status indicator icon based on the thresholds configured for the measure.
                                                                                                                                                                                                                                                                                                The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusIndicatorIcon":{ "type":"string", "description":"The status indicator icon based on the thresholds configured for the measure.
                                                                                                                                                                                                                                                                                                The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "targetExpressionValue":{ "type":"number", "description":"The target value of the strategy measure for the particular start and end value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualExpressionValue":{ "type":"number", "description":"This actual value of the strategy measure for the particular start and end value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "end":{ "type":"string", "description":"The end date time for the strategy measure value.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityStrategyProject":{ "title":"ApiEntityStrategyProject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "strategyProjectId":{ "type":"integer", "description":"The system-generated identifier of a project associated with a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "percentAlignment":{ "type":"number", "description":"The degree of alignment the project has to the strategy node. A single project can be aligned to multiple strategy nodes.", "format":"double", "exampleSetFlag":false }, "projectName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityStrategyProjectInput":{ "title":"ApiEntityStrategyProjectInput", "type":"object", "properties":{ "strategyProjectId":{ "type":"integer", "description":"The system-generated identifier of a project associated with a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "strategyId":{ "type":"integer", "description":"The system-generated identifier of a strategy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "percentAlignment":{ "type":"number", "description":"The degree of alignment the project has to the strategy node. A single project can be aligned to multiple strategy nodes.", "format":"double", "exampleSetFlag":false }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The system-generated identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a StrategyProject object, a unique StrategyProject object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                • strategyProjectId
                                                                                                                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityStrategyType":{ "title":"ApiEntityStrategyType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "levelName":{ "maxLength":255, "type":"string", "description":"The name of a strategy type.", "exampleSetFlag":false, "types":[ "string" ] }, "strategyTypeId":{ "type":"integer", "description":"The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                                                                                                                                                                                                  Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                                                                                                                                                                                  Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the strategy type and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "icon":{ "type":"string", "description":"A graphical representation of a strategy type.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "STRATEGY_ROOK", "STRATEGY_PAWN", "STRATEGY_KNIGHT", "STRATEGY_BISHOP", "STRATEGY_QUEEN", "STRATEGY_KING" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityStrategyTypeInput":{ "title":"ApiEntityStrategyTypeInput", "required":[ "icon", "levelName", "workspaceId" ], "type":"object", "properties":{ "levelName":{ "maxLength":255, "type":"string", "description":"The name of a strategy type.", "exampleSetFlag":false, "types":[ "string" ] }, "strategyTypeId":{ "type":"integer", "description":"The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The system-generated identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                                                                                                                                                                                                  Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                                                                                                                                                                                  Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "icon":{ "type":"string", "description":"A graphical representation of a strategy type.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "STRATEGY_ROOK", "STRATEGY_PAWN", "STRATEGY_KNIGHT", "STRATEGY_BISHOP", "STRATEGY_QUEEN", "STRATEGY_KING" ] } }, "description":"This entity represents a StrategyType object, a unique StrategyType object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                  • strategyTypeId
                                                                                                                                                                                                                                                                                                  • levelName,workspaceId
                                                                                                                                                                                                                                                                                                  • levelName,workspaceCode
                                                                                                                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityThreshold":{ "title":"ApiEntityThreshold", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"The type of a threshold. Thresholds of the value type use logical operators to measure fields against a set numeric value. Thresholds of the field type measure the value of one field against the value of another field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FIELD", "VALUE" ] }, "color":{ "maxLength":60, "type":"string", "description":"The bubble color is shown in the monitoring charts when the threshold criterion is met.", "exampleSetFlag":false, "types":[ "string" ] }, "columnUpperId":{ "type":"integer", "description":"The unique identifier of an upper column.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costValueUpper":{ "type":"number", "description":"The cost measured by the threshold.
                                                                                                                                                                                                                                                                                                    Use threshold operators to compare this value to the values in projects and portfolios.", "format":"double", "exampleSetFlag":false }, "integerValue":{ "type":"integer", "description":"The numeric value measured by the threshold.
                                                                                                                                                                                                                                                                                                    Use threshold operators to compare this value to the values in projects and portfolios.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "integerValueUpper":{ "type":"integer", "description":"The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\".
                                                                                                                                                                                                                                                                                                    High Value allows you to set a maximum value other threshold values can be measured against.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "numberValueUpper":{ "type":"number", "description":"The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\".
                                                                                                                                                                                                                                                                                                    High Value allows you to set a maximum value other threshold values can be measured against.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "typeUpper":{ "type":"string", "description":"Thresholds can have a type of Value or Field.
                                                                                                                                                                                                                                                                                                    Value: Uses the threshold logical operator to measure fields against a set numeric value.
                                                                                                                                                                                                                                                                                                    Field: Checks specified fields against a second field. For example, a threshold measuring Annual Discount Rate with an operator of Equals and a type of Field set to Forecast, will indicate if a project's Annual Discount Rate equals its Forecast.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FIELD", "VALUE" ] }, "thresholdId":{ "type":"integer", "description":"The unique identifier of a threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnId":{ "type":"integer", "description":"The unique identifier of a column.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "operator":{ "type":"string", "description":"The logical operator for the threshold.
                                                                                                                                                                                                                                                                                                    Values are measured against this logic.
                                                                                                                                                                                                                                                                                                    For example, a threshold with an operator of Equals will only display an indicator if the budget plan or project value it measures equals the value set in the threshold.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EQUALS", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN_EQUALS", "NOT_EQUALS", "LESS_THAN", "BETWEEN", "NOT_BETWEEN" ] }, "stringValue":{ "maxLength":30, "type":"string", "description":"The value of a threshold string.", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of a threshold in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "numberValue":{ "type":"number", "description":"The maximum value other threshold values are measured against.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"The value which other thresholds are measured against.", "format":"double", "exampleSetFlag":false }, "icon":{ "type":"string", "description":"The visual indicator associated with the threshold.
                                                                                                                                                                                                                                                                                                    The selected icon will display when threshold criteria is met.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "THREE_D", "CHECK", "CIRCLE", "CONTENT", "CORRECT", "DIAMOND", "ERROR", "EXCLAMATION", "FLAG", "HAPPY", "OK", "POP_UP", "SAD", "SQUARE", "STAR", "TARGET", "TRIANGLE", "WARNING", "X" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityThresholdInput":{ "title":"ApiEntityThresholdInput", "required":[ "operator" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"The type of a threshold. Thresholds of the value type use logical operators to measure fields against a set numeric value. Thresholds of the field type measure the value of one field against the value of another field.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FIELD", "VALUE" ] }, "color":{ "maxLength":60, "type":"string", "description":"The bubble color is shown in the monitoring charts when the threshold criterion is met.", "exampleSetFlag":false, "types":[ "string" ] }, "columnUpperId":{ "type":"integer", "description":"The unique identifier of an upper column.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "costValueUpper":{ "type":"number", "description":"The cost measured by the threshold.
                                                                                                                                                                                                                                                                                                    Use threshold operators to compare this value to the values in projects and portfolios.", "format":"double", "exampleSetFlag":false }, "integerValue":{ "type":"integer", "description":"The numeric value measured by the threshold.
                                                                                                                                                                                                                                                                                                    Use threshold operators to compare this value to the values in projects and portfolios.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "integerValueUpper":{ "type":"integer", "description":"The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\".
                                                                                                                                                                                                                                                                                                    High Value allows you to set a maximum value other threshold values can be measured against.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "numberValueUpper":{ "type":"number", "description":"The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\".
                                                                                                                                                                                                                                                                                                    High Value allows you to set a maximum value other threshold values can be measured against.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "typeUpper":{ "type":"string", "description":"Thresholds can have a type of Value or Field.
                                                                                                                                                                                                                                                                                                    Value: Uses the threshold logical operator to measure fields against a set numeric value.
                                                                                                                                                                                                                                                                                                    Field: Checks specified fields against a second field. For example, a threshold measuring Annual Discount Rate with an operator of Equals and a type of Field set to Forecast, will indicate if a project's Annual Discount Rate equals its Forecast.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FIELD", "VALUE" ] }, "thresholdId":{ "type":"integer", "description":"The unique identifier of a threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnId":{ "type":"integer", "description":"The unique identifier of a column.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "operator":{ "type":"string", "description":"The logical operator for the threshold.
                                                                                                                                                                                                                                                                                                    Values are measured against this logic.
                                                                                                                                                                                                                                                                                                    For example, a threshold with an operator of Equals will only display an indicator if the budget plan or project value it measures equals the value set in the threshold.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EQUALS", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN_EQUALS", "NOT_EQUALS", "LESS_THAN", "BETWEEN", "NOT_BETWEEN" ] }, "stringValue":{ "maxLength":30, "type":"string", "description":"The value of a threshold string.", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of a threshold in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "numberValue":{ "type":"number", "description":"The maximum value other threshold values are measured against.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"The value which other thresholds are measured against.", "format":"double", "exampleSetFlag":false }, "icon":{ "type":"string", "description":"The visual indicator associated with the threshold.
                                                                                                                                                                                                                                                                                                    The selected icon will display when threshold criteria is met.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "THREE_D", "CHECK", "CIRCLE", "CONTENT", "CORRECT", "DIAMOND", "ERROR", "EXCLAMATION", "FLAG", "HAPPY", "OK", "POP_UP", "SAD", "SQUARE", "STAR", "TARGET", "TRIANGLE", "WARNING", "X" ] } }, "description":"This entity represents a Threshold object, a unique Threshold object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                    • thresholdId
                                                                                                                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityUnitsOfMeasure":{ "title":"ApiEntityUnitsOfMeasure", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "displayName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the unit of measure.", "exampleSetFlag":false, "types":[ "string" ] }, "key":{ "maxLength":60, "minLength":0, "type":"string", "description":"The abbreviation for the unit of measure name.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the unit of measure.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the units of measure and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unique identifier for the unit of measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityUnitsOfMeasureInput":{ "title":"ApiEntityUnitsOfMeasureInput", "required":[ "displayName", "key", "workspaceId" ], "type":"object", "properties":{ "displayName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the unit of measure.", "exampleSetFlag":false, "types":[ "string" ] }, "key":{ "maxLength":60, "minLength":0, "type":"string", "description":"The abbreviation for the unit of measure name.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The code of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"The push down type of the unit of measure.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "unitOfMeasureId":{ "type":"integer", "description":"The unique identifier for the unit of measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a UnitsOfMeasure object, a unique UnitsOfMeasure object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                      • unitOfMeasureId
                                                                                                                                                                                                                                                                                                      • key,workspaceId
                                                                                                                                                                                                                                                                                                      • key,workspaceCode
                                                                                                                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityUser":{ "title":"ApiEntityUser", "type":"object", "properties":{ "officeIds":{ "type":"array", "description":"The list of unique identifiers for the offices.", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "federatedUser":{ "type":"boolean", "description":"Indicates if the user is a federated user.", "exampleSetFlag":false, "types":[ "boolean" ] }, "userSettings":{ "type":"array", "description":"A list of all user setting fields and values in the form of key value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityApplicationUserSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "userProducts":{ "type":"array", "description":"A list of all user product fields and values in the form of key value pairs. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUserProduct", "exampleSetFlag":false }, "types":[ "array" ] }, "ldapGuid":{ "maxLength":255, "minLength":1, "type":"string", "description":"The unique identifier in the external authentication system (LDAP or IDCS).", "exampleSetFlag":false, "types":[ "string" ] }, "userLocale":{ "type":"string", "description":"The language code for a user.
                                                                                                                                                                                                                                                                                                        1. pt_BR - Brazilian Portuguese
                                                                                                                                                                                                                                                                                                        2. nl - Dutch
                                                                                                                                                                                                                                                                                                        3. en - English
                                                                                                                                                                                                                                                                                                        4. fr - French
                                                                                                                                                                                                                                                                                                        5. de - German
                                                                                                                                                                                                                                                                                                        6. it - Italian
                                                                                                                                                                                                                                                                                                        7. ja - Japanese
                                                                                                                                                                                                                                                                                                        8. ko - Korean
                                                                                                                                                                                                                                                                                                        9. ru - Russian
                                                                                                                                                                                                                                                                                                        10. zh_CN - Simplified Chinese
                                                                                                                                                                                                                                                                                                        11. es - Spanish
                                                                                                                                                                                                                                                                                                        12. zh_TW - Traditional Chinese
                                                                                                                                                                                                                                                                                                        ", "exampleSetFlag":false, "types":[ "string" ] }, "lastName":{ "maxLength":150, "type":"string", "description":"The last name of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "userType":{ "type":"string", "description":"The type of the user.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "USER", "COMPANY_RESTRICTED", "APPLICATION_ADMIN", "IDEA_SUBMITTER" ] }, "firstName":{ "maxLength":150, "type":"string", "description":"The first name of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "restrictedUser":{ "type":"boolean", "description":"Indicates that the user can only access records associated with the assigned company.", "exampleSetFlag":false, "types":[ "boolean" ] }, "globalProfileId":{ "type":"string", "description":"The unique identifier for the global permission set.", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":255, "type":"string", "description":"The identification used by a user to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] }, "companyId":{ "type":"integer", "description":"The company the user is associated with.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "title":{ "maxLength":200, "type":"string", "description":"The title of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "userId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "phone":{ "maxLength":20, "type":"string", "description":"The phone number of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "email":{ "maxLength":255, "type":"string", "description":"The email address of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "mobile":{ "maxLength":20, "type":"string", "description":"The mobile phone number of a user.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityUserInput":{ "title":"ApiEntityUserInput", "required":[ "companyId", "email", "firstName", "lastName", "officeIds", "userLocale" ], "type":"object", "properties":{ "officeIds":{ "type":"array", "description":"The list of unique identifiers for the offices.", "exampleSetFlag":false, "items":{ "type":"integer", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "types":[ "array" ] }, "federatedUser":{ "type":"boolean", "description":"Indicates whether to create a federated user.
                                                                                                                                                                                                                                                                                                        Default value is false.
                                                                                                                                                                                                                                                                                                        ", "exampleSetFlag":false, "types":[ "boolean" ] }, "useExistingUser":{ "type":"boolean", "description":"Determines whether to reuse an existing user.
                                                                                                                                                                                                                                                                                                        Default value is true.
                                                                                                                                                                                                                                                                                                        ", "exampleSetFlag":false, "types":[ "boolean" ] }, "productNames":{ "type":"array", "description":"The list of license names.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PORTFOLIO", "PROGRESS", "SCHEDULE", "TASKS" ] }, "types":[ "array" ], "enum":[ "PORTFOLIO", "PROGRESS", "SCHEDULE", "TASKS" ] }, "userLocale":{ "type":"string", "description":"The language code for a user.
                                                                                                                                                                                                                                                                                                        1. pt_BR - Brazilian Portuguese
                                                                                                                                                                                                                                                                                                        2. nl - Dutch
                                                                                                                                                                                                                                                                                                        3. en - English
                                                                                                                                                                                                                                                                                                        4. fr - French
                                                                                                                                                                                                                                                                                                        5. de - German
                                                                                                                                                                                                                                                                                                        6. it - Italian
                                                                                                                                                                                                                                                                                                        7. ja - Japanese
                                                                                                                                                                                                                                                                                                        8. ko - Korean
                                                                                                                                                                                                                                                                                                        9. ru - Russian
                                                                                                                                                                                                                                                                                                        10. zh_CN - Simplified Chinese
                                                                                                                                                                                                                                                                                                        11. es - Spanish
                                                                                                                                                                                                                                                                                                        12. zh_TW - Traditional Chinese
                                                                                                                                                                                                                                                                                                        ", "exampleSetFlag":false, "types":[ "string" ] }, "lastName":{ "maxLength":150, "type":"string", "description":"The last name of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "userType":{ "type":"string", "description":"The type of the user.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "USER", "COMPANY_RESTRICTED", "APPLICATION_ADMIN", "IDEA_SUBMITTER" ] }, "firstName":{ "maxLength":150, "type":"string", "description":"The first name of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "globalProfileId":{ "type":"string", "description":"The unique identifier for the global permission set.", "exampleSetFlag":false, "types":[ "string" ] }, "companyId":{ "type":"integer", "description":"The system-generated identifier of a company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "title":{ "maxLength":200, "type":"string", "description":"The title of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "phone":{ "maxLength":20, "type":"string", "description":"The phone number of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "email":{ "maxLength":255, "type":"string", "description":"The email address of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "mobile":{ "maxLength":20, "type":"string", "description":"The mobile phone number of a user.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityApplicationUserInput":{ "title":"ApiEntityApplicationUserInput", "required":[ "email", "firstName", "lastName" ], "type":"object", "properties":{ "userProducts":{ "type":"array", "description":"A list of all user product fields and values in the form of key value pairs. ", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityUserProductInput", "exampleSetFlag":false }, "types":[ "array" ] }, "ldapGuid":{ "maxLength":255, "minLength":1, "type":"string", "description":"The unique identifier in the external authentication system (LDAP or IDCS).", "exampleSetFlag":false, "types":[ "string" ] }, "userLocale":{ "type":"string", "description":"The language code for a user.
                                                                                                                                                                                                                                                                                                        1. pt_BR - Brazilian Portuguese
                                                                                                                                                                                                                                                                                                        2. nl - Dutch
                                                                                                                                                                                                                                                                                                        3. en - English
                                                                                                                                                                                                                                                                                                        4. fr - French
                                                                                                                                                                                                                                                                                                        5. de - German
                                                                                                                                                                                                                                                                                                        6. it - Italian
                                                                                                                                                                                                                                                                                                        7. ja - Japanese
                                                                                                                                                                                                                                                                                                        8. ko - Korean
                                                                                                                                                                                                                                                                                                        9. ru - Russian
                                                                                                                                                                                                                                                                                                        10. zh_CN - Simplified Chinese
                                                                                                                                                                                                                                                                                                        11. es - Spanish
                                                                                                                                                                                                                                                                                                        12. zh_TW - Traditional Chinese
                                                                                                                                                                                                                                                                                                        ", "exampleSetFlag":false, "types":[ "string" ] }, "lastName":{ "maxLength":100, "type":"string", "description":"The last name of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "userType":{ "type":"string", "description":"The type of the user.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "USER", "COMPANY_RESTRICTED", "APPLICATION_ADMIN", "IDEA_SUBMITTER" ] }, "firstName":{ "maxLength":100, "type":"string", "description":"The first name of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "title":{ "maxLength":25, "type":"string", "description":"The title of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "maxLength":20, "type":"string", "description":"Determines the status of the user. When a user is inactive, they can no longer have access to login. Valid Values are ACTIVE and INACTIVE. ", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "userId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "phone":{ "maxLength":100, "type":"string", "description":"The phone number of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "email":{ "maxLength":320, "type":"string", "description":"The email address of a user.", "exampleSetFlag":false, "types":[ "string" ] }, "mobile":{ "maxLength":100, "type":"string", "description":"The mobile phone number of a user.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ApplicationUser object, a unique ApplicationUser object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                        • userId
                                                                                                                                                                                                                                                                                                        • email
                                                                                                                                                                                                                                                                                                        • ldapGuid
                                                                                                                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityUserProductInput":{ "title":"ApiEntityUserProductInput", "type":"object", "properties":{ "userProductId":{ "type":"integer", "description":"The system-generated identifier for the user product.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "productId":{ "type":"integer", "description":"The system-generated unique identifier of a license.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "productName":{ "type":"string", "description":"The name of the license.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IDEA", "PORTFOLIO", "PROGRESS", "SCHEDULE", "TASKS" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete the particular nested entry in the list of user products. A valid productName value must be provided to perform deletion.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueWBS":{ "title":"ApiEntityCodeValueWBS", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueWbsId":{ "type":"integer", "description":"The unique identifier of a WBS code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"The unique identifier of a WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWBS":{ "title":"ApiEntityWBS", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "isDelete":{ "type":"boolean", "description":"Indicates whether or not the WBS is marked for deletion.", "exampleSetFlag":false, "types":[ "boolean" ] }, "parentWBSCodes":{ "type":"array", "description":"The list of parent WBS codes in the hierarchy of a WBS. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs. If required, the field 'wbsPath' can be referred to get the value for the parent WBS path.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A summary of the purpose for the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueWBS", "exampleSetFlag":false }, "types":[ "array" ] }, "sequenceNumber":{ "type":"integer", "description":"The sequence number of a WBS.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The system-generated identifier of the parent WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "managerId":{ "type":"integer", "description":"The system-generated identifier of manager or person responsible for monitoring and providing status on the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of the parent of a WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a WBS.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWBSConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"Unique identifier of the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "wbsName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "wbsPath":{ "maxLength":4000, "type":"string", "description":"The complete path to the WBS. This is the hierarchy path from the Project Code to the WBS. It is based on the following pattern: <ProjectCode>.<WSBCode>.<WSBCode>...<WBSCode>. For example, for a project with code 'P1' having the WBS hierarchy as 'WBS1', 'WBS2', and 'WBS3', the wbsPath for 'WBS3' will be defined as 'P1.WBS1.WBS2.WBS3'.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWBSConfiguredFieldValue":{ "title":"ApiEntityWBSConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "wbsConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the WBS Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"Unique identifier of the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueWBSInput":{ "title":"ApiEntityCodeValueWBSInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueWbsId":{ "type":"integer", "description":"The unique identifier of a WBS code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"The unique identifier of a WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueWBS object, a unique CodeValueWBS object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                          • codeValueWbsId
                                                                                                                                                                                                                                                                                                          • codeValueId
                                                                                                                                                                                                                                                                                                          • codeTypeId,codeValueCode
                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode
                                                                                                                                                                                                                                                                                                          • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                                                                                                                          • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityWBSConfiguredFieldValueInput":{ "title":"ApiEntityWBSConfiguredFieldValueInput", "type":"object", "properties":{ "wbsConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the WBS Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"Unique identifier of the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a WBSConfiguredFieldValue object, a unique WBSConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                            • wbsConfiguredFieldValueId
                                                                                                                                                                                                                                                                                                            • columnDefinitionId
                                                                                                                                                                                                                                                                                                            • columnName
                                                                                                                                                                                                                                                                                                            • columnLabel
                                                                                                                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityWBSInput":{ "title":"ApiEntityWBSInput", "required":[ "projectId" ], "type":"object", "properties":{ "parentWBSCodes":{ "type":"array", "description":"The list of parent WBS codes in the hierarchy of a WBS. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs. If required, the field 'wbsPath' can be referred to get the value for the parent WBS path.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"A summary of the purpose for the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a WBS. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueWBSInput", "exampleSetFlag":false }, "types":[ "array" ] }, "sequenceNumber":{ "type":"integer", "description":"The sequence number of a WBS.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The system-generated identifier of the parent WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "managerId":{ "type":"integer", "description":"The system-generated identifier of manager or person responsible for monitoring and providing status on the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a WBS.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWBSConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsId":{ "type":"integer", "description":"Unique identifier of the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "wbsName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the WBS.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a WBS object, a unique WBS object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                              • wbsId
                                                                                                                                                                                                                                                                                                              • wbsCode,projectId,parentId
                                                                                                                                                                                                                                                                                                              • wbsCode,projectCode,workspaceCode,parentId
                                                                                                                                                                                                                                                                                                              • wbsCode,projectCode,workspaceCode,parentWBSCodes
                                                                                                                                                                                                                                                                                                              • wbsCode,projectId,parentWBSCodes
                                                                                                                                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityNotebookTopicWBS":{ "title":"ApiEntityNotebookTopicWBS", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "wbsNotesId":{ "type":"integer", "description":"The unique identifier for the notebook topic and its wbs association.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicId":{ "type":"integer", "description":"The unique identifier for the notebook topic.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notebookTopicName":{ "maxLength":255, "type":"string", "description":"The name of the notebook topic.", "exampleSetFlag":false, "types":[ "string" ] }, "parentId":{ "type":"integer", "description":"The system-generated identifier of the parent WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "notes":{ "type":"string", "description":"The notes for the notebook topic in HTML format.", "exampleSetFlag":false, "types":[ "string" ] }, "wbsId":{ "type":"integer", "description":"Unique identifier of the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueWorkManagerTask":{ "title":"ApiEntityCodeValueWorkManagerTask", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueTasksId":{ "type":"integer", "description":"The unique identifier of a code value of a task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskId":{ "type":"integer", "description":"The unique identifier of a task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityReason":{ "title":"ApiEntityReason", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "reasonId":{ "type":"integer", "description":"The unique identifier of a reason.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reasonName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the reason for recommitting to a task.", "exampleSetFlag":false, "types":[ "string" ] }, "abbreviation":{ "maxLength":60, "minLength":1, "type":"string", "description":"The abbreviation of the reason for recommitting to a task.", "exampleSetFlag":false, "types":[ "string" ] }, "appliesTo":{ "type":"array", "description":"Indicates the type of object the reason is associated to. ", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TASKS", "CHANGE_EVENT" ] }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                                                                                                                                                                                                                Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                                                                                                                                                                                                Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the reason and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkManagerTask":{ "title":"ApiEntityWorkManagerTask", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"The type of task. Valid values are Task and Task Milestone.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TASK", "TASK_MILESTONE" ] }, "workManagerTaskCommitments":{ "type":"array", "description":"List of task commitments associated with the task.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskCommitment", "exampleSetFlag":false }, "types":[ "array" ] }, "originalCommitmentDueDate":{ "type":"string", "description":"The original due date of the task commitment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "isMissingActivityAssignment":{ "type":"boolean", "description":"Tasks that are missing Activity assignment.", "exampleSetFlag":false, "types":[ "boolean" ] }, "durationHours":{ "minimum":0, "type":"number", "description":"The total amount of expected time required to complete the task, in days.", "format":"double", "exampleSetFlag":false }, "visibility":{ "type":"string", "description":"The visibility of task. Valid values are Private and Public.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PUBLIC", "PRIVATE" ] }, "tentativeDate":{ "type":"string", "description":"The date by which the task is expected to be completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "completedDate":{ "type":"string", "description":"The date when the task was completed. This field is set automatically when the task is completed. ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "activityDateStatus":{ "type":"string", "description":"Indicates the overall date status of the activity's assigned tasks.
                                                                                                                                                                                                                                                                                                                Outside Activity: A task's dates are outside of the activity's Start and Finish dates.
                                                                                                                                                                                                                                                                                                                Inside Activity: All of the tasks' dates are within the activity's Start and Finish dates.
                                                                                                                                                                                                                                                                                                                No Tasks Assigned: No tasks are assigned to the activity.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "INSIDE_ACTIVITY", "OUTSIDE_ACTIVITY", "NO_ACTIVITY" ] }, "activityCompleteStatus":{ "type":"string", "description":"Indicates the completion status of the activity and its assigned tasks.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NO_ACTIVITY", "ACTIVITY_COMPLETE_TASK_NOT", "TASK_COMPLETE_ACTIVITY_NOT", "BOTH_COMPLETE", "BOTH_NOT_COMPLETE" ] }, "favorite":{ "type":"boolean", "description":"Indicates whether or not the work manager task is marked as favorite.", "exampleSetFlag":false, "types":[ "boolean" ] }, "commitmentCount":{ "type":"integer", "description":"The number of commitments on a task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "predecessorCount":{ "type":"integer", "description":"The number of predecessor hand-offs assigned to the task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "successorCount":{ "type":"integer", "description":"The number of successor hand-offs assigned to the task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "proposedDueDate":{ "type":"string", "description":"The date proposed for the task due date. Proposed Due Dates do not affect task Due Dates until they are accepted.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "latestCommitmentDueDate":{ "type":"string", "description":"The current due date of the task commitment.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "isDueThisWeek":{ "type":"boolean", "description":"Tasks that are due within the calendar week from Sunday to Saturday.", "exampleSetFlag":false, "types":[ "boolean" ] }, "hasSlack":{ "type":"boolean", "description":"Task slack is the amount of time a task can be delayed before it impacts the start date of the most immediate hand-off successor.", "exampleSetFlag":false, "types":[ "boolean" ] }, "hasCommitments":{ "type":"boolean", "description":"Tasks that contain commitments to due dates.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isUnassigned":{ "type":"boolean", "description":"Tasks that do not have a user assigned.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isPending":{ "type":"boolean", "description":"Tasks that have a due date but are not committed, or tasks that are committed but the due date has been changed.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isUnplanned":{ "type":"boolean", "description":"Tasks without a due date.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isOutsideActivity":{ "type":"boolean", "description":"Tasks with due dates that occur before the activity start date or after the activity end date.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isSchNonWorkDays":{ "type":"boolean", "description":"Tasks that occur on non-work days as defined by the project calendar when Use Only Work Days is selected.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isOverdue":{ "type":"boolean", "description":"Tasks that have not been completed by their due date.", "exampleSetFlag":false, "types":[ "boolean" ] }, "hasProposedDueDate":{ "type":"boolean", "description":"Tasks that have a proposed due date value that has not yet been accepted.", "exampleSetFlag":false, "types":[ "boolean" ] }, "constraintCount":{ "type":"integer", "description":"The number of constraints assigned to the selected task or task milestone.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "hasConstraints":{ "type":"boolean", "description":"Indicates whether the selected task or task milestone has any constraints assigned.", "exampleSetFlag":false, "types":[ "boolean" ] }, "parentWbsId":{ "type":"integer", "description":"The system-generated identifier of the parent WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crewSize":{ "maximum":99, "minimum":1, "type":"integer", "description":"The number of people planned to work on the task.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the task.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The name of the company that owns the task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyPostalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyColor":{ "maxLength":6, "minLength":1, "type":"string", "description":"The selected color representation of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "taskConstraints":{ "type":"array", "description":"List of work manager task constraints.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityTaskConstraint", "exampleSetFlag":false }, "types":[ "array" ] }, "workManagerTaskId":{ "type":"integer", "description":"The unique identifier of a task. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a work manager task. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueWorkManagerTask", "exampleSetFlag":false }, "types":[ "array" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of a task within a task hierarchy.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The activity to which the task is assigned. The activity must have a Type of Activity Dependent or Resource Dependent.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "startDate":{ "type":"string", "description":"The date when the task is set to begin.
                                                                                                                                                                                                                                                                                                                If the task is set to allow non-work days, the date is calculated as Due Date minus Duration plus 1 day.
                                                                                                                                                                                                                                                                                                                If the task is not set to allow non-work days, the date is calculated as Due Date minus the sum of Duration plus Non-Work Days, plus 1 day.
                                                                                                                                                                                                                                                                                                                This is a read-only field.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "useCalendar":{ "type":"boolean", "description":"Enables the user to allow only the project calendar's work days and ignore non-work days when determining the value for Start and Due Date.", "exampleSetFlag":false, "types":[ "boolean" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "itemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier assigned to the task.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a work manager task.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The current status of the task. Valid values are New, Pending, Committed, and Completed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NEW", "PENDING", "COMMITTED", "COMPLETED" ] }, "project":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userId":{ "type":"integer", "description":"The person responsible for the task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "overdue":{ "type":"boolean", "description":"Tasks that have not been completed by their due date.", "exampleSetFlag":false, "types":[ "boolean" ] }, "wbsId":{ "type":"integer", "description":"Unique identifier of the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "wbsPath":{ "maxLength":4000, "type":"string", "description":"The path to the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "slack":{ "minimum":0, "type":"number", "description":"The amount of time a task can be delayed before it affects the start date of its most immediate successor. This is a read-only field.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkManagerTaskCommitment":{ "title":"ApiEntityWorkManagerTaskCommitment", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workManagerTaskCommitmentId":{ "type":"integer", "description":"The unique identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "taskName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the task.", "exampleSetFlag":false, "types":[ "string" ] }, "addByUserId":{ "type":"integer", "description":"The username of the user who added the item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "timezoneDateAdded":{ "type":"string", "description":"The date on which the commitment was added.", "format":"date-time", "exampleSetFlag":false }, "workManagerTaskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier assigned to the task.", "exampleSetFlag":false, "types":[ "string" ] }, "comments":{ "maxLength":4000, "minLength":1, "type":"string", "description":"The comments captured with a task commitment.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The system-generated identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyPostalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyColor":{ "maxLength":6, "minLength":1, "type":"string", "description":"The selected color representation of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "workManagerTaskId":{ "type":"integer", "description":"The unique identifier for the work manager task.The work manager task object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "applicationUserId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "createDate":{ "type":"string", "description":"The date on which work manager task commitment was created.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the commitment. Valid values are Committed and Recommitted.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COMMITTED", "RECOMMITTED" ] }, "reasons":{ "type":"array", "description":"The reasons of a work manager task commitment.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReason", "exampleSetFlag":false }, "types":[ "array" ] }, "dueDate":{ "type":"string", "description":"The date by which the task is expected to be completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkManagerTaskConfiguredFieldValue":{ "title":"ApiEntityWorkManagerTaskConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workManagerTaskConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Task Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskId":{ "type":"integer", "description":"The system-generated identifier of a Task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueWorkManagerTaskInput":{ "title":"ApiEntityCodeValueWorkManagerTaskInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueTasksId":{ "type":"integer", "description":"The unique identifier of a code value of a task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskId":{ "type":"integer", "description":"The unique identifier of a task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueWorkManagerTask object, a unique CodeValueWorkManagerTask object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                • codeValueTasksId
                                                                                                                                                                                                                                                                                                                • codeValueId
                                                                                                                                                                                                                                                                                                                • codeTypeId,codeValueCode
                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode
                                                                                                                                                                                                                                                                                                                • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                                                                                                                                • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityWorkManagerTaskConfiguredFieldValueInput":{ "title":"ApiEntityWorkManagerTaskConfiguredFieldValueInput", "type":"object", "properties":{ "workManagerTaskConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Task Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskId":{ "type":"integer", "description":"The system-generated identifier of a Task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a WorkManagerTaskConfiguredFieldValue object, a unique WorkManagerTaskConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                  • workManagerTaskConfiguredFieldValueId
                                                                                                                                                                                                                                                                                                                  • columnDefinitionId
                                                                                                                                                                                                                                                                                                                  • columnName
                                                                                                                                                                                                                                                                                                                  • columnLabel
                                                                                                                                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityWorkManagerTaskInput":{ "title":"ApiEntityWorkManagerTaskInput", "required":[ "project", "visibility" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"The type of task. Valid values are Task and Task Milestone.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TASK", "TASK_MILESTONE" ] }, "durationHours":{ "minimum":0, "type":"number", "description":"The total amount of expected time required to complete the task, in days.", "format":"double", "exampleSetFlag":false }, "visibility":{ "type":"string", "description":"The visibility of task. Valid values are Private and Public.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PUBLIC", "PRIVATE" ] }, "tentativeDate":{ "type":"string", "description":"The date by which the task is expected to be completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "completedDate":{ "type":"string", "description":"The date when the task was completed. This field is set automatically when the task is completed. ", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "favorite":{ "type":"boolean", "description":"Indicates whether or not the work manager task is marked as favorite.", "exampleSetFlag":false, "types":[ "boolean" ] }, "proposedDueDate":{ "type":"string", "description":"The date proposed for the task due date. Proposed Due Dates do not affect task Due Dates until they are accepted.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "hasProposedDueDate":{ "type":"boolean", "description":"Tasks that have a proposed due date value that has not yet been accepted.", "exampleSetFlag":false, "types":[ "boolean" ] }, "parentWbsId":{ "type":"integer", "description":"The system-generated identifier of the parent WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "crewSize":{ "maximum":99, "minimum":1, "type":"integer", "description":"The number of people planned to work on the task.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the task.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The name of the company that owns the task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyPostalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyColor":{ "maxLength":6, "minLength":1, "type":"string", "description":"The selected color representation of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "taskConstraints":{ "type":"array", "description":"List of work manager task constraints.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityTaskConstraintInput", "exampleSetFlag":false }, "types":[ "array" ] }, "workManagerTaskId":{ "type":"integer", "description":"The unique identifier of a task. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a work manager task. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueWorkManagerTaskInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The activity to which the task is assigned. The activity must have a Type of Activity Dependent or Resource Dependent.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "useCalendar":{ "type":"boolean", "description":"Enables the user to allow only the project calendar's work days and ignore non-work days when determining the value for Start and Due Date.", "exampleSetFlag":false, "types":[ "boolean" ] }, "itemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier assigned to the task.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a work manager task.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkManagerTaskConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The current status of the task. Valid values are New, Pending, Committed, and Completed.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NEW", "PENDING", "COMMITTED", "COMPLETED" ] }, "project":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userId":{ "type":"integer", "description":"The person responsible for the task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "overdue":{ "type":"boolean", "description":"Tasks that have not been completed by their due date.", "exampleSetFlag":false, "types":[ "boolean" ] }, "wbsId":{ "type":"integer", "description":"Unique identifier of the WBS.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "wbsCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the WBS.", "exampleSetFlag":false, "types":[ "string" ] }, "wbsPath":{ "maxLength":4000, "type":"string", "description":"The path to the WBS.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a WorkManagerTask object, a unique WorkManagerTask object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                    • workManagerTaskId
                                                                                                                                                                                                                                                                                                                    • itemCode,project,projectCompanyId
                                                                                                                                                                                                                                                                                                                    • itemCode,projectCode,workspaceCode,projectCompanyId
                                                                                                                                                                                                                                                                                                                    • itemCode,project,companyName,companyPostalCode,projectCompanyColor
                                                                                                                                                                                                                                                                                                                    • itemCode,projectCode,workspaceCode,companyName,companyPostalCode,projectCompanyColor
                                                                                                                                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityWorkManagerTaskFavoriteInput":{ "title":"ApiEntityWorkManagerTaskFavoriteInput", "required":[ "favorite", "workManagerTaskId" ], "type":"object", "properties":{ "favorite":{ "type":"boolean", "description":"Indicates whether or not the work manager task is marked as favorite.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workManagerTaskId":{ "type":"integer", "description":"The unique identifier of a task. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityWorkManagerTaskDependency":{ "title":"ApiEntityWorkManagerTaskDependency", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"The hand-off dependency type. The valid value is Finish to Start.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "FINISH_TO_START", "START_TO_START", "FINISH_TO_FINISH" ] }, "workManagerTaskDependencyId":{ "type":"integer", "description":"The system-generated identifier of a work manager task dependency. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "successorTaskId":{ "type":"integer", "description":"The unique identifier of a successor task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "predecessorTaskId":{ "type":"integer", "description":"The unique identifier of a predecessor task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "successorTaskName":{ "maxLength":255, "minLength":1, "type":"string", "description":"Task name of the successor Task.", "exampleSetFlag":false, "types":[ "string" ] }, "predecessorTaskName":{ "maxLength":255, "minLength":1, "type":"string", "description":"Task name of the predecessor Task.", "exampleSetFlag":false, "types":[ "string" ] }, "predecessorTaskStatus":{ "type":"string", "description":"Task status of the predecessor Task.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NEW", "PENDING", "COMMITTED", "COMPLETED" ] }, "predecessorTaskCompany":{ "type":"string", "description":"Company assigned to the predecessor Task.", "exampleSetFlag":false, "types":[ "string" ] }, "predecessorTaskDueDate":{ "type":"string", "description":"Last committed due date of the predecessor Task.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "successorTaskStatus":{ "type":"string", "description":"Task status of the successor Task.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NEW", "PENDING", "COMMITTED", "COMPLETED" ] }, "successorTaskCompany":{ "type":"string", "description":"Company assigned to the successor Task.", "exampleSetFlag":false, "types":[ "string" ] }, "successorTaskDueDate":{ "type":"string", "description":"Last committed due date of the successor Task.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "useCalendar":{ "type":"boolean", "description":"Allows user to set whether or not lag can fall on project calendar's nonwork days.", "exampleSetFlag":false, "types":[ "boolean" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of the project to which the dependency belongs.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "slack":{ "minimum":0, "type":"number", "description":"The amount of time between a predecessor task's due date and its successor task's start date. This is a read-only field.", "format":"double", "exampleSetFlag":false }, "lag":{ "minimum":0, "type":"number", "description":"The amount of time a successor task is required to be delayed with respect to a predecessor task in a hand-off, in hours. ", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueWorkPackage":{ "title":"ApiEntityCodeValueWorkPackage", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueWorkPackageId":{ "type":"integer", "description":"The unique identifier of a work package code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkPackage":{ "title":"ApiEntityWorkPackage", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "installedUnits":{ "type":"number", "description":"Installed quantity of scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "percentCompleteWeightedBy":{ "type":"string", "description":"The weight is calculated using cost, quantity, hours, or manually entered values. Cost, Quantity, and Hours are represented as n in the equations that follow.
                                                                                                                                                                                                                                                                                                                      The n weight is first calculated for each scope assignment in the work package as Revised n multiplied by the scope assignment Scope Percent Complete.
                                                                                                                                                                                                                                                                                                                      Scope Percent Complete is calculated as Installed Quantity divided by At Completion Quantity.
                                                                                                                                                                                                                                                                                                                      The sum of the scope assignments Revised n and the sum of the scope assignments n Weight for all scope assignments in the work package are then used to compute the work package Scope Percent Complete. This is calculated as the n Weight divided by Revised n.
                                                                                                                                                                                                                                                                                                                      Completed Weight for the Manual option is calculated as Manual Weight multiplied by Scope Percent Complete.
                                                                                                                                                                                                                                                                                                                      Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Completed Weight divided by the sum of Manual Weight for all scope assignments in the work package.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COST", "QUANTITY", "HOURS", "MANUAL" ] }, "remainingEarlyFinishDate":{ "type":"string", "description":"The earliest date the work on the work package is scheduled to finish.
                                                                                                                                                                                                                                                                                                                      If there is no activity link, this field is populated with the latest Remaining Early Finish date of all its scope assignments. If the work package does not have scope assignments, the field is populated the Original Finish date before the original baseline is set and the Revised Finish date after the original baseline is set.
                                                                                                                                                                                                                                                                                                                      This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
                                                                                                                                                                                                                                                                                                                      If there is an activity linked, this field is populated with the latest Remaining Early Finish date of all linked activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "ruleOfCredit":{ "description":"The name of the rule of credit which includes a set of milestones for which progress is measured.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRuleOfCredit" } ] }, "workPackageCost":{ "description":"The cost of the work package.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityWorkPackageCost" } ] }, "effectiveDate":{ "type":"string", "description":"The latest Effective Finish date of all scope assignments in the work package.
                                                                                                                                                                                                                                                                                                                      This is a read-only field.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Provides additional details about the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "spendsHours":{ "minimum":0, "type":"number", "description":"Calculated as the sum of Actual Hours to Date for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "eacWithSpendsHours":{ "type":"number", "description":"Calculated as ETC Hours plus Spends Hours for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "activityWeightMethod":{ "type":"string", "description":"The method used to calculate Activity Percent Complete. Methods are Duration, Labor Units, Non Labor Units, and Manual.
                                                                                                                                                                                                                                                                                                                      Duration: Planned Duration, also known as Original Duration, is used for Weight.
                                                                                                                                                                                                                                                                                                                      Labor Units: At Completion Labor Units is used for Weight.
                                                                                                                                                                                                                                                                                                                      Non Labor Units: At Completion NonLabor Units is used for Weight.
                                                                                                                                                                                                                                                                                                                      Manual: Weight is added manually.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DURATION", "LABOR_UNITS", "NON_LABOR_UNITS", "MANUAL" ] }, "budgetCompleteMethod":{ "type":"string", "description":"The setting allows users to select which value to use for populating BAC fields when a baseline is set. Choose At Completion to include adjusted values.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REVISED", "AT_COMPLETION" ] }, "percentCompleteMethod":{ "type":"string", "description":"The method used to measure progress.
                                                                                                                                                                                                                                                                                                                      Milestone Percent Complete: This option uses a selected Rule of Credit to measure progress.
                                                                                                                                                                                                                                                                                                                      Physical Percent Complete: This option allows users to manually enter Installed Quantity for scope assignments.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MILESTONE_PERCENT_COMPLETE", "PHYSICAL_PERCENT_COMPLETE" ] }, "milestoneProgressType":{ "type":"string", "description":"Determines how the milestones are progressed if the Progress Measure is set to Milestone Percent Complete.
                                                                                                                                                                                                                                                                                                                      Sequential: Milestones must be progressed in order.
                                                                                                                                                                                                                                                                                                                      Non Sequential: Milestones can be progressed in whatever order necessary.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SEQUENTIAL", "NON_SEQUENTIAL" ] }, "effectiveStartDate":{ "type":"string", "description":"The earliest Effective Start date of all scope assignments in the work package.
                                                                                                                                                                                                                                                                                                                      This is a read-only field.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingEarlyStartDate":{ "type":"string", "description":"The earliest date the work on the work package is scheduled to begin.
                                                                                                                                                                                                                                                                                                                      If the work package does not have scope assignments, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, it inherits the Data Date when the Modify Dates feature is run if the work package's Scope Percent Complete is not equal to 100%.
                                                                                                                                                                                                                                                                                                                      This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
                                                                                                                                                                                                                                                                                                                      If there is any activity linked, this field is populated with the earliest Remaining Early Start date of all linked activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinishDate":{ "type":"string", "description":"The date the work on the work package is scheduled to finish.
                                                                                                                                                                                                                                                                                                                      If there is no activity link, this field is populated with the Original Finish date until the original baseline is set. It can be manually modified after the original baseline is set.
                                                                                                                                                                                                                                                                                                                      If Data Date is specified after the Planned Finish date is set and the Planned Start date is before the Data Date, the application sets the Planned Finish date to be the same date relative to Planned Start before the Data Date was modified when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                                                      If there is an activity link, this field is populated with the latest Planned Finish date of all activities in the work package.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStartDate":{ "type":"string", "description":"The latest possible date work on the work package must begin without delaying the finish date.
                                                                                                                                                                                                                                                                                                                      If there is no activity link, this field is always equal to the Remaining Late Start date of all scope assignments in the work package. If the work package does not have scope assignments, this field is populated with the Remaining Early Start date.
                                                                                                                                                                                                                                                                                                                      If there is any activity linked, this field is populated with the earliest Remaining Late Start date of all activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinishDate":{ "type":"string", "description":"The latest possible date work on the work package must finish to not delay the finish date.
                                                                                                                                                                                                                                                                                                                      If there is no activity link, this field is populated with the latest Remaining Late Finish date of all its scope assignments. If the work package does not have scope assignments, the field is populated with the Remaining Early Finish date.
                                                                                                                                                                                                                                                                                                                      If there is an activity linked, this field is populated with the latest Remaining Late Finish date of all linked activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "activityPercentComplete":{ "minimum":0, "type":"number", "description":"The percentage complete for all activities assigned to the work package.", "format":"double", "exampleSetFlag":false }, "plannedStartDate":{ "type":"string", "description":"The date the work on the work package is scheduled to begin.
                                                                                                                                                                                                                                                                                                                      If there is no activity link, this field is populated with the Original Start date until the original baseline is set. It can be manually updated after the original baseline is set.
                                                                                                                                                                                                                                                                                                                      If the Data Date is specified, the date cannot be set to a date earlier than the Data Date.
                                                                                                                                                                                                                                                                                                                      If the Data Date is specified after the Planned Start date is set, the Planned Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, that is Installed Quantity is zero, then the date inherits the Data Date when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                                                      If there is an activity link, this field is populated with the earliest Planned Start date of all the activities in the work package.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageId":{ "type":"integer", "description":"The ID for the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "earnedPercentComplete":{ "minimum":0, "type":"number", "description":"Calculated as Earned Hours divided by BAC Hours for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "originalStartDate":{ "type":"string", "description":"The date the work on the work package is scheduled to begin.
                                                                                                                                                                                                                                                                                                                      This field is populated with the Data Date with the work package is created, but it can be manually modified until the Original Baseline is set.
                                                                                                                                                                                                                                                                                                                      If the Data Date is specified, Original Start cannot be set to a date earlier than the Data Date. If the Data Date is specified after the Original Start date is set and the Original Start date is before the Data Date, the Original Start is populated with the Data Date when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                                                      If there is no activity link, this field is locked when the original baseline is set.
                                                                                                                                                                                                                                                                                                                      If there is an activity link, before the original baseline is set this field is populated with the earliest Planned Start dates of all linked activities. After the baseline is set, the field is locked.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "originalFinishDate":{ "type":"string", "description":"The date the work on the work package is scheduled to finish.
                                                                                                                                                                                                                                                                                                                      This field is populated with the Data Date plus 4 days when the work package is created, but it can be manually modified until the Original Baseline is set.
                                                                                                                                                                                                                                                                                                                      If the Data Date is specified after the Original Finish date is set and the Original Start date is before the Data Date, the application sets the Original Finish date to be the same date relative to Original Start before the Data Date was modified when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                                                      If there is no activity link, the field is locked when the original baseline is set.
                                                                                                                                                                                                                                                                                                                      If there is an activity link, before the original baseline is set the field is populated with the earliest Planned Finish date of all linked activities. After the baseline is set, the field is locked.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "revisedStartDate":{ "type":"string", "description":"The revised start date for the work package.
                                                                                                                                                                                                                                                                                                                      If the work package does not have scope assignments, this field is populated with the Original Start date until the original baseline is set.
                                                                                                                                                                                                                                                                                                                      This field is populated with the Data Date when the Modify Dates feature is run after the original baseline is set if the Revised Start date is before the Data Date and the work package's Scope Percent Complete is equal to 0%.
                                                                                                                                                                                                                                                                                                                      If the work package has scope assignments, is always the earliest start of its scope assignments' Planned Start dates and all approved Change Start dates.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "revisedFinishDate":{ "type":"string", "description":"The revised finish date for the work package.
                                                                                                                                                                                                                                                                                                                      If the work package does not have scope assignments, this field is populated with the Original Finish date until the original baseline is set.
                                                                                                                                                                                                                                                                                                                      When the Modify Dates feature is run after the original baseline is set, the Revised Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, the Revised Finish date is updated to be the same date relative to the Revised Start date as it was before the Data Date was modified.
                                                                                                                                                                                                                                                                                                                      If the work package has scope assignments, the date is always the latest finish of its scope assignments' Planned Finish dates and all approved Change Finish dates.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "installedStartDate":{ "type":"string", "description":"The date work on the work package began.
                                                                                                                                                                                                                                                                                                                      This is the earliest Installed Start date of all scope assignments in the work package.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "installedFinishDate":{ "type":"string", "description":"The date work on the work package is complete.
                                                                                                                                                                                                                                                                                                                      This is the latest Installed Finish date of all scope assignments in the work package.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineStartDate":{ "type":"string", "description":"The planned start date for the work package as is set in the current baseline.
                                                                                                                                                                                                                                                                                                                      This field is populated with the Revised Start date at the time that the current baseline is set.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineFinishDate":{ "type":"string", "description":"The planned finish date for the work package as is set in the current baseline.
                                                                                                                                                                                                                                                                                                                      This field is populated with the Revised Finish date at the time that the current baseline is set.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "percentComplete":{ "type":"number", "description":"The weight is calculated using cost, quantity, hours, or manually entered values. Cost, Quantity, and Hours are represented as n in the equations that follow.
                                                                                                                                                                                                                                                                                                                      The n weight is first calculated for each scope assignment in the work package as Revised n multiplied by the scope assignment Scope Percent Complete.
                                                                                                                                                                                                                                                                                                                      Scope Percent Complete is calculated as Installed Quantity divided by At Completion Quantity.
                                                                                                                                                                                                                                                                                                                      The sum of the scope assignments Revised n and the sum of the scope assignments n Weight for all scope assignments in the work package are then used to compute the work package Scope Percent Complete. This is calculated as the n Weight divided by Revised n.
                                                                                                                                                                                                                                                                                                                      Weight for the Manual option is calculated as Manual Weight Factor multiplied by Scope Percent Complete.
                                                                                                                                                                                                                                                                                                                      Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Weight divided by the sum of Manual Weight Factors for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "codeValues":{ "type":"array", "description":"The list of code values for a work package. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueWorkPackage", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified unique identifier of the workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedHours":{ "minimum":0, "type":"number", "description":"The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
                                                                                                                                                                                                                                                                                                                      Calculated as Original Quantity multiplied by Original Productivity Rate.
                                                                                                                                                                                                                                                                                                                      Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"Calculated as the sum of all pending hour changes in the change and transfer records for the scope assignment.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The sum of all approved change hours in the change and transfer records for the scope assignment.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "minimum":0, "type":"number", "description":"Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "minimum":0, "type":"number", "description":"The Revised Hours at the time the baseline was set.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "etcHours":{ "minimum":0, "type":"number", "description":"The estimated number of hours needed to complete the work.
                                                                                                                                                                                                                                                                                                                      Calculated as BAC Hours minus Earned Hours.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "eacHours":{ "minimum":0, "type":"number", "description":"The total hours estimated to be earned at the completion of the work package.
                                                                                                                                                                                                                                                                                                                      Calculated as ETC Hours plus Actual Hours to Date.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "earnedHours":{ "minimum":0, "type":"number", "description":"The portion of budgeted hours that is currently earned for the work package.
                                                                                                                                                                                                                                                                                                                      Calculated as Performance Percent Complete multiplied by BAC Hours.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "etcAdjustedHours":{ "minimum":0, "type":"number", "description":"The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "actualHoursToDate":{ "minimum":0, "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "bacHours":{ "minimum":0, "type":"number", "description":"The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "remainingHours":{ "minimum":0, "type":"number", "description":"The number of hours left for the scope assignment.
                                                                                                                                                                                                                                                                                                                      Calculated as Remaining Quantity multiplied by Revised Productivity Rate.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "installedHours":{ "minimum":0, "type":"number", "description":"Hours spent on the scope assignment.
                                                                                                                                                                                                                                                                                                                      Calculated as Installed Quantity multiplied by Revised Productivity Rate.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "atCompletionHours":{ "minimum":0, "type":"number", "description":"The total hours expected to be spend at the completion of the scope assignment.
                                                                                                                                                                                                                                                                                                                      Calculated as Revised Hours plus Adjusted Hours.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a work package.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkPackageConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manager":{ "type":"integer", "description":"The manager or person responsible for the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the work package.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ] }, "wbsId":{ "type":"integer", "description":"The unique identifier for the wbs.The wbs object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "curveId":{ "type":"integer", "description":"The curve profile used for time phase distribution of scope assignments.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkPackageConfiguredFieldValue":{ "title":"ApiEntityWorkPackageConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Work Package Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageId":{ "type":"integer", "description":"The ID for the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkPackageCost":{ "title":"ApiEntityWorkPackageCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "eacWithSpendsCostProject":{ "type":"number", "description":"Calculated as ETC cost plus spends cost for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "pendingChangedCostProject":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency. ", "format":"double", "exampleSetFlag":false }, "approvedChangedCostProject":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "spendsCost":{ "type":"number", "description":"Calculated as the sum of Actual Cost to Date for all scope assignments in the work package. This field is in base currency and is calculated from spendsCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "spendsCostProject":{ "type":"number", "description":"Calculated as the sum of actual cost to date for all scope assignments in the work package. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "eacWithSpendsCost":{ "type":"number", "description":"Calculated as ETC Cost plus Spends Cost for all scope assignments in the work package. This field is in base currency and is calculated from eacWithSpendsCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "workPackageId":{ "type":"integer", "description":"The ID for the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "plannedCostProject":{ "type":"number", "description":"The original cost of the scope assignment.
                                                                                                                                                                                                                                                                                                                      If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
                                                                                                                                                                                                                                                                                                                      If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "revisedCostProject":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "eacCostProject":{ "type":"number", "description":"The total cost estimated to be earned as the completion of the work package.
                                                                                                                                                                                                                                                                                                                      Calculated as ETC Cost plus Actual Cost to Date.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "etcCostProject":{ "type":"number", "description":"The estimate of the cost needed to complete the work.
                                                                                                                                                                                                                                                                                                                      Calculated as BAC Cost minus Earned Cost.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "earnedCostProject":{ "type":"number", "description":"The portion of the budgeted cost that is currently earned for the work package.
                                                                                                                                                                                                                                                                                                                      Calculated as Performance Percent Complete multiplied by BAC Cost.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "baselineCostProject":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "actualCostToDateProject":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done).
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "bacCostProject":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "atCompletionCostProject":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                                                                                                                                                                                                                                                                      Calculated as Revised Cost plus Adjusted Cost.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingCostProject":{ "type":"number", "description":"The amount left to be spent.
                                                                                                                                                                                                                                                                                                                      If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                                                                                                                                                                                                                                                                      If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "installedCostProject":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                                                                                                                                                                                                                                                                      If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                                                                                                                                                                                                                                                                      If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "adjustedCostProject":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package of a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "plannedCost":{ "type":"number", "description":"The original cost of the scope assignment.
                                                                                                                                                                                                                                                                                                                      If Rate By is set to Hours, then Original Cost equals Original Hours multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Hours.
                                                                                                                                                                                                                                                                                                                      If Rate By is set to Quantity, then Original Cost equals Original Quantity multiplied by Original Cost Rate. If this value is entered manually, then Original Cost Rate is recalculated to equal Original Cost divided by Original Quantity.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from plannedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "pendingChangedCost":{ "type":"number", "description":"Calculated as the sum of all pending cost changes in the change records for the scope assignment.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from pendingChangedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "approvedChangedCost":{ "type":"number", "description":"The sum of all approved cost changes in the change records for the scope assignment.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from approvedChangedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "revisedCost":{ "type":"number", "description":"The Original Cost before the baseline is set. After the baseline is set, Revised Cost equals Original Cost plus Approved Change Cost.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from revisedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "baselineCost":{ "type":"number", "description":"The Revised Cost at the time the current baseline was set.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from baselineCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "earnedCost":{ "type":"number", "description":"The portion of the budgeted cost that is currently earned for the work package.
                                                                                                                                                                                                                                                                                                                      Calculated as Performance Percent Complete multiplied by BAC Cost.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from earnedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "actualCostToDate":{ "type":"number", "description":"The actual costs incurred on the scope assignment. This tracks the VOWD (Value of Work Done).
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from actualCostToDateProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "remainingCost":{ "type":"number", "description":"The amount left to be spent.
                                                                                                                                                                                                                                                                                                                      If Rate By set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                                                                                                                                                                                                                                                                      If Rate By set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from remainingCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "installedCost":{ "type":"number", "description":"The total cost incurred on the scope assignment as of the current date.
                                                                                                                                                                                                                                                                                                                      If Rate By is set to Hours, then Installed Cost equals Revised Cost Rate multiplied by Installed Hours.
                                                                                                                                                                                                                                                                                                                      If Rate By is set to Quantity, then Installed Cost equals Revised Cost Rate multiplied by Installed Quantity.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from installedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "adjustedCost":{ "type":"number", "description":"The amount the scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from adjustedCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "atCompletionCost":{ "type":"number", "description":"The total cost at the completion of the scope assignment.
                                                                                                                                                                                                                                                                                                                      Calculated as Revised Cost plus Adjusted Cost.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from atCompletionCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "etcCost":{ "type":"number", "description":"The estimate of the cost needed to complete the work.
                                                                                                                                                                                                                                                                                                                      Calculated as BAC Cost minus Earned Cost.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from etcCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "eacCost":{ "type":"number", "description":"The total cost estimated to be earned as the completion of the work package.
                                                                                                                                                                                                                                                                                                                      Calculated as ETC Cost plus Actual Cost to Date.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from eacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "bacCost":{ "type":"number", "description":"The Revised Cost or At Completion Cost at the time the current baseline was set, depending on the selection for the Budget at Completion Method. The Revised Cost of the current project if no baseline is set.
                                                                                                                                                                                                                                                                                                                      This is the cumulative value for all scope assignments in the work package. This field is in base currency and is calculated from bacCostProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueWorkPackageInput":{ "title":"ApiEntityCodeValueWorkPackageInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueWorkPackageId":{ "type":"integer", "description":"The unique identifier of a work package code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageId":{ "type":"integer", "description":"The unique identifier of a work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueWorkPackage object, a unique CodeValueWorkPackage object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                      • codeValueWorkPackageId
                                                                                                                                                                                                                                                                                                                      • codeValueId
                                                                                                                                                                                                                                                                                                                      • codeTypeId,codeValueCode
                                                                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode
                                                                                                                                                                                                                                                                                                                      • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                                                                                                                                      • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                                                                                                                                      • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityWorkPackageConfiguredFieldValueInput":{ "title":"ApiEntityWorkPackageConfiguredFieldValueInput", "type":"object", "properties":{ "workPackageConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for the Work Package Configured Field.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageId":{ "type":"integer", "description":"The ID for the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a WorkPackageConfiguredFieldValue object, a unique WorkPackageConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                        • workPackageConfiguredFieldValueId
                                                                                                                                                                                                                                                                                                                        • columnDefinitionId
                                                                                                                                                                                                                                                                                                                        • columnName
                                                                                                                                                                                                                                                                                                                        • columnLabel
                                                                                                                                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityWorkPackageInput":{ "title":"ApiEntityWorkPackageInput", "required":[ "originalFinishDate", "originalStartDate", "projectId", "wbsId", "workPackageName" ], "type":"object", "properties":{ "installedUnits":{ "type":"number", "description":"Installed quantity of scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "percentCompleteWeightedBy":{ "type":"string", "description":"The weight is calculated using cost, quantity, hours, or manually entered values. Cost, Quantity, and Hours are represented as n in the equations that follow.
                                                                                                                                                                                                                                                                                                                          The n weight is first calculated for each scope assignment in the work package as Revised n multiplied by the scope assignment Scope Percent Complete.
                                                                                                                                                                                                                                                                                                                          Scope Percent Complete is calculated as Installed Quantity divided by At Completion Quantity.
                                                                                                                                                                                                                                                                                                                          The sum of the scope assignments Revised n and the sum of the scope assignments n Weight for all scope assignments in the work package are then used to compute the work package Scope Percent Complete. This is calculated as the n Weight divided by Revised n.
                                                                                                                                                                                                                                                                                                                          Completed Weight for the Manual option is calculated as Manual Weight multiplied by Scope Percent Complete.
                                                                                                                                                                                                                                                                                                                          Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Completed Weight divided by the sum of Manual Weight for all scope assignments in the work package.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COST", "QUANTITY", "HOURS", "MANUAL" ] }, "remainingEarlyFinishDate":{ "type":"string", "description":"The earliest date the work on the work package is scheduled to finish.
                                                                                                                                                                                                                                                                                                                          If there is no activity link, this field is populated with the latest Remaining Early Finish date of all its scope assignments. If the work package does not have scope assignments, the field is populated the Original Finish date before the original baseline is set and the Revised Finish date after the original baseline is set.
                                                                                                                                                                                                                                                                                                                          This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
                                                                                                                                                                                                                                                                                                                          If there is an activity linked, this field is populated with the latest Remaining Early Finish date of all linked activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "ruleOfCredit":{ "description":"The name of the rule of credit which includes a set of milestones for which progress is measured.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityRuleOfCreditInput" } ] }, "wbsCodes":{ "type":"array", "description":"The list of WBS codes in a hierarchy of a work package.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "effectiveDate":{ "type":"string", "description":"The latest Effective Finish date of all scope assignments in the work package.
                                                                                                                                                                                                                                                                                                                          This is a read-only field.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Provides additional details about the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "spendsHours":{ "minimum":0, "type":"number", "description":"Calculated as the sum of Actual Hours to Date for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "eacWithSpendsHours":{ "type":"number", "description":"Calculated as ETC Hours plus Spends Hours for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "activityWeightMethod":{ "type":"string", "description":"The method used to calculate Activity Percent Complete. Methods are Duration, Labor Units, Non Labor Units, and Manual.
                                                                                                                                                                                                                                                                                                                          Duration: Planned Duration, also known as Original Duration, is used for Weight.
                                                                                                                                                                                                                                                                                                                          Labor Units: At Completion Labor Units is used for Weight.
                                                                                                                                                                                                                                                                                                                          Non Labor Units: At Completion NonLabor Units is used for Weight.
                                                                                                                                                                                                                                                                                                                          Manual: Weight is added manually.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DURATION", "LABOR_UNITS", "NON_LABOR_UNITS", "MANUAL" ] }, "budgetCompleteMethod":{ "type":"string", "description":"The setting allows users to select which value to use for populating BAC fields when a baseline is set. Choose At Completion to include adjusted values.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REVISED", "AT_COMPLETION" ] }, "percentCompleteMethod":{ "type":"string", "description":"The method used to measure progress.
                                                                                                                                                                                                                                                                                                                          Milestone Percent Complete: This option uses a selected Rule of Credit to measure progress.
                                                                                                                                                                                                                                                                                                                          Physical Percent Complete: This option allows users to manually enter Installed Quantity for scope assignments.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MILESTONE_PERCENT_COMPLETE", "PHYSICAL_PERCENT_COMPLETE" ] }, "milestoneProgressType":{ "type":"string", "description":"Determines how the milestones are progressed if the Progress Measure is set to Milestone Percent Complete.
                                                                                                                                                                                                                                                                                                                          Sequential: Milestones must be progressed in order.
                                                                                                                                                                                                                                                                                                                          Non Sequential: Milestones can be progressed in whatever order necessary.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SEQUENTIAL", "NON_SEQUENTIAL" ] }, "effectiveStartDate":{ "type":"string", "description":"The earliest Effective Start date of all scope assignments in the work package.
                                                                                                                                                                                                                                                                                                                          This is a read-only field.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingEarlyStartDate":{ "type":"string", "description":"The earliest date the work on the work package is scheduled to begin.
                                                                                                                                                                                                                                                                                                                          If the work package does not have scope assignments, before the original baseline is set, this field is populated with the Original Start date. After the original baseline is set, it inherits the Data Date when the Modify Dates feature is run if the work package's Scope Percent Complete is not equal to 100%.
                                                                                                                                                                                                                                                                                                                          This field is blank when the scope assignment's Scope Percent Complete becomes 100%.
                                                                                                                                                                                                                                                                                                                          If there is any activity linked, this field is populated with the earliest Remaining Early Start date of all linked activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "plannedFinishDate":{ "type":"string", "description":"The date the work on the work package is scheduled to finish.
                                                                                                                                                                                                                                                                                                                          If there is no activity link, this field is populated with the Original Finish date until the original baseline is set. It can be manually modified after the original baseline is set.
                                                                                                                                                                                                                                                                                                                          If Data Date is specified after the Planned Finish date is set and the Planned Start date is before the Data Date, the application sets the Planned Finish date to be the same date relative to Planned Start before the Data Date was modified when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                                                          If there is an activity link, this field is populated with the latest Planned Finish date of all activities in the work package.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateStartDate":{ "type":"string", "description":"The latest possible date work on the work package must begin without delaying the finish date.
                                                                                                                                                                                                                                                                                                                          If there is no activity link, this field is always equal to the Remaining Late Start date of all scope assignments in the work package. If the work package does not have scope assignments, this field is populated with the Remaining Early Start date.
                                                                                                                                                                                                                                                                                                                          If there is any activity linked, this field is populated with the earliest Remaining Late Start date of all activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "remainingLateFinishDate":{ "type":"string", "description":"The latest possible date work on the work package must finish to not delay the finish date.
                                                                                                                                                                                                                                                                                                                          If there is no activity link, this field is populated with the latest Remaining Late Finish date of all its scope assignments. If the work package does not have scope assignments, the field is populated with the Remaining Early Finish date.
                                                                                                                                                                                                                                                                                                                          If there is an activity linked, this field is populated with the latest Remaining Late Finish date of all linked activities.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "activityPercentComplete":{ "minimum":0, "type":"number", "description":"The percentage complete for all activities assigned to the work package.", "format":"double", "exampleSetFlag":false }, "plannedStartDate":{ "type":"string", "description":"The date the work on the work package is scheduled to begin.
                                                                                                                                                                                                                                                                                                                          If there is no activity link, this field is populated with the Original Start date until the original baseline is set. It can be manually updated after the original baseline is set.
                                                                                                                                                                                                                                                                                                                          If the Data Date is specified, the date cannot be set to a date earlier than the Data Date.
                                                                                                                                                                                                                                                                                                                          If the Data Date is specified after the Planned Start date is set, the Planned Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, that is Installed Quantity is zero, then the date inherits the Data Date when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                                                          If there is an activity link, this field is populated with the earliest Planned Start date of all the activities in the work package.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageId":{ "type":"integer", "description":"The ID for the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workPackageName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "earnedPercentComplete":{ "minimum":0, "type":"number", "description":"Calculated as Earned Hours divided by BAC Hours for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "originalStartDate":{ "type":"string", "description":"The date the work on the work package is scheduled to begin.
                                                                                                                                                                                                                                                                                                                          This field is populated with the Data Date with the work package is created, but it can be manually modified until the Original Baseline is set.
                                                                                                                                                                                                                                                                                                                          If the Data Date is specified, Original Start cannot be set to a date earlier than the Data Date. If the Data Date is specified after the Original Start date is set and the Original Start date is before the Data Date, the Original Start is populated with the Data Date when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                                                          If there is no activity link, this field is locked when the original baseline is set.
                                                                                                                                                                                                                                                                                                                          If there is an activity link, before the original baseline is set this field is populated with the earliest Planned Start dates of all linked activities. After the baseline is set, the field is locked.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "originalFinishDate":{ "type":"string", "description":"The date the work on the work package is scheduled to finish.
                                                                                                                                                                                                                                                                                                                          This field is populated with the Data Date plus 4 days when the work package is created, but it can be manually modified until the Original Baseline is set.
                                                                                                                                                                                                                                                                                                                          If the Data Date is specified after the Original Finish date is set and the Original Start date is before the Data Date, the application sets the Original Finish date to be the same date relative to Original Start before the Data Date was modified when the Modify Dates feature is run.
                                                                                                                                                                                                                                                                                                                          If there is no activity link, the field is locked when the original baseline is set.
                                                                                                                                                                                                                                                                                                                          If there is an activity link, before the original baseline is set the field is populated with the earliest Planned Finish date of all linked activities. After the baseline is set, the field is locked.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "revisedStartDate":{ "type":"string", "description":"The revised start date for the work package.
                                                                                                                                                                                                                                                                                                                          If the work package does not have scope assignments, this field is populated with the Original Start date until the original baseline is set.
                                                                                                                                                                                                                                                                                                                          This field is populated with the Data Date when the Modify Dates feature is run after the original baseline is set if the Revised Start date is before the Data Date and the work package's Scope Percent Complete is equal to 0%.
                                                                                                                                                                                                                                                                                                                          If the work package has scope assignments, is always the earliest start of its scope assignments' Planned Start dates and all approved Change Start dates.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "revisedFinishDate":{ "type":"string", "description":"The revised finish date for the work package.
                                                                                                                                                                                                                                                                                                                          If the work package does not have scope assignments, this field is populated with the Original Finish date until the original baseline is set.
                                                                                                                                                                                                                                                                                                                          When the Modify Dates feature is run after the original baseline is set, the Revised Start date is before the Data Date, and the work package's Scope Percent Complete is equal to 0%, the Revised Finish date is updated to be the same date relative to the Revised Start date as it was before the Data Date was modified.
                                                                                                                                                                                                                                                                                                                          If the work package has scope assignments, the date is always the latest finish of its scope assignments' Planned Finish dates and all approved Change Finish dates.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "installedStartDate":{ "type":"string", "description":"The date work on the work package began.
                                                                                                                                                                                                                                                                                                                          This is the earliest Installed Start date of all scope assignments in the work package.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "installedFinishDate":{ "type":"string", "description":"The date work on the work package is complete.
                                                                                                                                                                                                                                                                                                                          This is the latest Installed Finish date of all scope assignments in the work package.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineStartDate":{ "type":"string", "description":"The planned start date for the work package as is set in the current baseline.
                                                                                                                                                                                                                                                                                                                          This field is populated with the Revised Start date at the time that the current baseline is set.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "baselineFinishDate":{ "type":"string", "description":"The planned finish date for the work package as is set in the current baseline.
                                                                                                                                                                                                                                                                                                                          This field is populated with the Revised Finish date at the time that the current baseline is set.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "percentComplete":{ "type":"number", "description":"The weight is calculated using cost, quantity, hours, or manually entered values. Cost, Quantity, and Hours are represented as n in the equations that follow.
                                                                                                                                                                                                                                                                                                                          The n weight is first calculated for each scope assignment in the work package as Revised n multiplied by the scope assignment Scope Percent Complete.
                                                                                                                                                                                                                                                                                                                          Scope Percent Complete is calculated as Installed Quantity divided by At Completion Quantity.
                                                                                                                                                                                                                                                                                                                          The sum of the scope assignments Revised n and the sum of the scope assignments n Weight for all scope assignments in the work package are then used to compute the work package Scope Percent Complete. This is calculated as the n Weight divided by Revised n.
                                                                                                                                                                                                                                                                                                                          Weight for the Manual option is calculated as Manual Weight Factor multiplied by Scope Percent Complete.
                                                                                                                                                                                                                                                                                                                          Scope Percent Complete at the work package level for the manual option is calculated as the sum of Manual Weight divided by the sum of Manual Weight Factors for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "codeValues":{ "type":"array", "description":"The list of code values for a work package. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueWorkPackageInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier of the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified unique identifier of the workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedHours":{ "minimum":0, "type":"number", "description":"The original expected hours needed to complete all the work required to install the material quantity on the scope assignment.
                                                                                                                                                                                                                                                                                                                          Calculated as Original Quantity multiplied by Original Productivity Rate.
                                                                                                                                                                                                                                                                                                                          Before the baseline is set, this field can be entered manually. A manual entry recalculates the Original Productivity Rate to equal Original Hours divided by Original Quantity.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "pendingChangedHours":{ "type":"number", "description":"Calculated as the sum of all pending hour changes in the change and transfer records for the scope assignment.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "approvedChangedHours":{ "type":"number", "description":"The sum of all approved change hours in the change and transfer records for the scope assignment.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "revisedHours":{ "minimum":0, "type":"number", "description":"Original Hours before the baseline is set. After the baseline is set, Revised Hours is equal to Original Hours plus Approved Change Hours.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "baselineHours":{ "minimum":0, "type":"number", "description":"The Revised Hours at the time the baseline was set.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "etcHours":{ "minimum":0, "type":"number", "description":"The estimated number of hours needed to complete the work.
                                                                                                                                                                                                                                                                                                                          Calculated as BAC Hours minus Earned Hours.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "eacHours":{ "minimum":0, "type":"number", "description":"The total hours estimated to be earned at the completion of the work package.
                                                                                                                                                                                                                                                                                                                          Calculated as ETC Hours plus Actual Hours to Date.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "earnedHours":{ "minimum":0, "type":"number", "description":"The portion of budgeted hours that is currently earned for the work package.
                                                                                                                                                                                                                                                                                                                          Calculated as Performance Percent Complete multiplied by BAC Hours.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "etcAdjustedHours":{ "minimum":0, "type":"number", "description":"The amount of scope assignment work that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "actualHoursToDate":{ "minimum":0, "type":"number", "description":"The actual hours spent on the scope assignment. This tracks the VOWD (Value of Work Done).
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "bacHours":{ "minimum":0, "type":"number", "description":"The Revised Hours or At Completion Hours at the time the current baseline was set, depending on the selection for the Budget At Completion Method. The Revised Hours of the current project if no baseline is set.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "remainingHours":{ "minimum":0, "type":"number", "description":"The number of hours left for the scope assignment.
                                                                                                                                                                                                                                                                                                                          Calculated as Remaining Quantity multiplied by Revised Productivity Rate.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "installedHours":{ "minimum":0, "type":"number", "description":"Hours spent on the scope assignment.
                                                                                                                                                                                                                                                                                                                          Calculated as Installed Quantity multiplied by Revised Productivity Rate.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "atCompletionHours":{ "minimum":0, "type":"number", "description":"The total hours expected to be spend at the completion of the scope assignment.
                                                                                                                                                                                                                                                                                                                          Calculated as Revised Hours plus Adjusted Hours.
                                                                                                                                                                                                                                                                                                                          This is the cumulative value for all scope assignments in the work package.", "format":"double", "exampleSetFlag":false }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a work package.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkPackageConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manager":{ "type":"integer", "description":"The manager or person responsible for the work package.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "status":{ "type":"string", "description":"The status of the work package.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ] }, "wbsId":{ "type":"integer", "description":"The unique identifier for the wbs.The wbs object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "curveId":{ "type":"integer", "description":"The curve profile used for time phase distribution of scope assignments.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a WorkPackage object, a unique WorkPackage object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                          • workPackageId
                                                                                                                                                                                                                                                                                                                          • workPackageCode,projectId,wbsId
                                                                                                                                                                                                                                                                                                                          • workPackageCode,projectCode,workspaceCode,wbsId
                                                                                                                                                                                                                                                                                                                          • workPackageCode,projectId,wbsCodes
                                                                                                                                                                                                                                                                                                                          • workPackageCode,projectCode,workspaceCode,wbsCodes
                                                                                                                                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityPreExecutionValidationProblem":{ "title":"ApiEntityPreExecutionValidationProblem", "type":"object", "properties":{ "type":{ "type":"string", "description":"Specifies the type of the task associated with the step the workflow is on.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "GLOBAL_ARE_YOU_SURE_YOU_WANT_TO_CANCEL", "GLOBAL_CONFIRM_DELETE_GRID_ROW", "GLOBAL_CONFIRM_ENABLE_GRID_ROW", "GLOBAL_CONFIRM_DELETE_REPORT_LAYOUT", "GLOBAL_UNSAVED_CHANGES_CONFIRM", "GLOBAL_UNSAVED_CHANGES", "GLOBAL_MAINTENANCE_INFORMATION", "GLOBAL_MAINTENANCE_STATUS", "GLOBAL_MAINTENANCE_STATUS_PAGE", "GRID_PRINT_COMPLETE", "GRID_PRINT_RENDER_IN_BACKGROUND", "FAILED_TO_PRINT_GRID", "EXCEL_IMPORT_SUCCES", "EXCEL_IMPORT_FAILED", "EXCEL_IMPORT_TERMINATED", "EXCEL_IMPORT_SUCCES_WORKSPACE", "EXCEL_IMPORT_SUCCES_PORTFOLIO", "EXCEL_IMPORT_FAILED_WORKSPACE", "EXCEL_IMPORT_FAILED_PORTFOLIO", "EXCEL_IMPORT_TERMINATED_WORKSPACE", "EXCEL_IMPORT_TERMINATED_PORTFOLIO", "EXCEL_IMPORT_SUCCES_PROGRAM", "EXCEL_IMPORT_FAILED_PROGRAM", "EXCEL_IMPORT_TERMINATED_PROGRAM", "EXCEL_IMPORT_UNRECOVERABLE_FAIL", "EXCEL_IMPORT_COMMENT_FIRST_ROW", "EXCEL_IMPORT_COMMENT_SECOND_ROW", "EXCEL_IMPORT_ERROR_COLUMN", "EXCEL_IMPORT_ERROR_EMPTY_SHEET", "EXCEL_UNRECOVERABLE_ERROR_COLUMN_NAME", "EXCEL_DOWNLOAD_READY", "EXCEL_DOWNLOAD_FAILED_CONTEXT", "EXCEL_DOWNLOAD_FAILED_MESSAGE", "GENERIC_IMPORT_ERR_REJECTED_COLUMN", "GENERIC_IMPORT_ERR_REJECTED_ROW", "GENERIC_IMPORT_SUCCESSFUL", "GENERIC_COST_PRIVILEGE_WARNING", "LOGIN_COPYRIGHT_HEADER", "CONFIRM_LOGOUT_PAGE_CONFIRMATION", "CONFIRM_FORMULA_TO_MANUAL_NO_ASSIGNMENTS", "TRADEMARK_NOTICE", "SESSIONTIMEOUT_EXPIRED_MESSAGE", "SESSIONTIMEOUT_SIGNBACK_MESSAGE", "UDF_CREATE_FAILED", "UDF_CREATE_SUCCESS", "UDF_CREATE_SUCCESS_MESSAGE", "UDF_REFRESH_WARNING", "EXPORT_SUCCESS", "EXPORT_FAIL", "SCHEDULE_COMPARISON_EXPORT_SUCCESS", "SCHEDULE_COMPARISON_EXPORT_FAIL", "MSP_EXPORT_SUCCESS", "MSP_EXPORT_FAIL", "EXPORT_PRIMAVERA_CLOUD_PROJ_DATA_TO_MSP", "VALIDATION_NUMBER_BETWEEN", "VALIDATION_NUMBER_STRICTLY_WITHIN", "NEWSFEED_DOCUMENTS_CREATE_DOCUMENT", "NEWSFEED_DOCUMENTS_CREATE_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_CREATE_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_CREATE_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_DOCUMENTS_UPDATE_DOCUMENT", "NEWSFEED_DOCUMENTS_UPDATE_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_UPDATE_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_UPDATE_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_DOCUMENTS_DELETE_DOCUMENT", "NEWSFEED_DOCUMENTS_DELETE_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_DELETE_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_DELETE_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_DOCUMENTS_CHECKIN_DOCUMENT", "NEWSFEED_DOCUMENTS_CHECKIN_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_CHECKIN_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_CHECKIN_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_DOCUMENTS_CHECKOUT_DOCUMENT", "NEWSFEED_DOCUMENTS_CHECKOUT_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_CHECKOUT_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_CHECKOUT_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_BUDGET_APPROVED_MESSAGE", "NEWSFEED_RESOURCE_APPROVED_MESSAGE", "NEWSFEED_BUDGET_PROPOSED_MESSAGE", "TOTAL_ALLOCATION_UNITS_LESS_ARE_LESS", "VALIDATION_UNIQUE", "VALIDATION_REQUIRED", "VALIDATION_STARTDATE_AFTER_FINISHDATE", "VALIDATION_FINISHDATE_BEFORE_STARTDATE", "VALIDATION_STARTDATE_EMPTY", "VALIDATION_FINISHDATE_EMPTY", "VALIDATION_STARTDATE_BEFORE_FY_YEAR", "FILTER_FIELD_NOT_RECOGNIZED", "FILTER_FIELD_UNAVAILABLE", "FILTER_FIELD_NO_RECOGNIZED_VALUE", "FILTER_FIELD_BAD_VALUE", "FILTER_FIELD_CODE_DOESNT_EXIST", "FILTER_FIELD_DELETED", "FILTER_FIELD_VALUE_DELETED", "FILTER_FIELD_CODE_NAME_UNKNOWN", "FILTER_FIELD_OBJECT_UNKNOWN", "UDF_INDICATOR_HIGHVALUE_TOO_LOW", "UDF_FORMULA_VALIDATION_PASSED", "PROJECTPICKER_GROUP_BY_WORKSPACE", "PROJECTPICKER_GROUP_BY_PROJECT_CODES", "CP_MONITORINGTHRESHOLDS_CONFIRM_DELETE", "CP_MONITORSCORECARD_NO_APPROVED_SCENARIO", "CP_PROJECTINVENTORY_CONFIRM_DELETE", "CP_PROJECTINVENTORY_CONFIRM_DELETE_WORKSPACE_WITH_CHILDREN", "CP_PROJECTINVENTORY_CONFIRM_DELETE_WORKSPACE", "CP_PROJECTINVENTORY_CONFIRM_DELETE_PROJECT", "CP_PROJECTINVENTORY_EXCHANGE_RATE_LOCKED", "CP_PROJECTINVENTORY_ADD_PROJECT_UNIQUE", "CP_PROJECTINVENTORY_CANNOT_SWITCH_GROUPING", "CP_PROJECTINVENTORY_DELETE_PERMANENTLY", "CP_PROJECTINVENTORY_MARK_AS_INACTIVE", "CP_PROJECTINVENTORY_ARCHIVE", "CP_PROJECTINVENTORY_CONFIRM_REMOVE_PROJECTS_MAPPED_TO_SCOPE_OR_CP", "CP_PROJECTINVENTORY_TEMPLATE_RUNNING_ASYNC", "SELECT_FIELDS_INSTRUCTIONS", "CP_MANAGEWORKSPACES_CONFIRM_DELETE_WORKSPACE", "CP_CAPITALPORTFOLIOINVENTORY_CONFIRM_DELETE_WITH_PLANS", "CP_CAPITALPORTFOLIOINVENTORY_CONFIRM_DELETE_NO_PLANS", "CP_CAPITALPORTFOLIOINVENTORY_PLANNING_HORIZON_DESC", "CP_CAPITALPORTFOLIOINVENTORY_NOT_ENABLED", "CP_CAPITALPORTFOLIOINVENTORY_ENABLE_CAPITAL_PLAN_HELP", "PROJECT_PORTFOLIO_REMOVE_MANUALLY_ADDED_ALERT", "CP_BUDGETPLANNING_OPTIMIZATION_MESSAGE_SINGLE", "CP_BUDGETPLANNING_OPTIMIZATION_MESSAGE_PLURAL", "CP_BUDGETPLANNING_OPTIMIZATION_MESSAGE_AND", "CP_BUDGETPLANNING_OPTIMIZATION_SUGGESTION", "CP_BUDGETPLANNING_OPTIMIZATION_SAVE", "CP_BUDGETPLANNING_OPTIMIZATION_FAILURE", "CP_BUDGETPLANNING_PLAN_PERIOD_CONFIRMATION", "CP_BUDGETPLANNING_SWITCH_SCENARIO_CONFIRMATION", "CP_BUDGETCHANGEDETAILS_CONFIRMATION", "CP_BUDGETCHANGEDETAILS_APPROVE_CONFIRMATION", "CP_BUDGETCHANGEDETAILS_REJECT_CONFIRMATION", "CP_BUDGETCHANGEDETAILS_WITHDRAW_CONFIRMATION", "CP_BUDGETTRANSFERDETAILS_APPROVE_CONFIRMATION", "CP_BUDGETTRANSFERDETAILS_REJECT_CONFIRMATION", "CP_BUDGETTRANSFERDETAILS_WITHDRAW_CONFIRMATION", "BP_NOBUDGET_WARNING_CHANGE_STATE", "CP_BUDGET_APPROVED_MESSAGE_HEADER", "CP_BUDGET_APPROVED_MESSAGE", "CP_BUDGET_PROPOSED_MESSAGE_HEADER", "CP_BUDGET_PROPOSED_MESSAGE", "CP_REVIEW_NOTIFICATION", "CP_REVIEW_NOTIFICATION_DESC", "CP_APPROVAL_NOTIFICATION", "CP_APPROVAL_NOTIFICATION_DESC", "CP_SHARED_NOTIFICATION", "CP_SHARED_NOTIFICATION_DESC", "CP_LINK_ALL_COMPLETED", "CP_LINK_ALL_COMPLETED_DESC", "CP_LINK_ALL_FAILED", "CP_LINK_ALL_FAILED_DESC", "CP_SCENARIO_APPROVAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "CP_SCENARIO_APPROVAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "CP_SCENARIO_APPROVAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "CP_SCENARIO_APPROVAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "CP_SCENARIO_PROPOSAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "CP_SCENARIO_PROPOSAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "CP_SCENARIO_PROPOSAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "CP_SCENARIO_PROPOSAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "CP_SCENARIO_IN_PLANNING_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "CP_SCENARIO_IN_PLANNING_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "CP_SCENARIO_IN_PLANNING_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "CP_SCENARIO_IN_PLANNING_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "BP_OPTIMIZATION_BACKGROUND_JOB_IN_PROGRESS", "BP_OPTIMIZATION_SUCCESS_CONTEXT", "BP_OPTIMIZATION_FAILURE_CONTEXT", "BP_OPTIMIZATION_SUCCESS", "BP_OPTIMIZATION_FAILURE", "BP_SCENARIO_PROPOSE_BACKGROUND_JOB_IN_PROGRESS", "BP_SCENARIO_PROPOSE_BACKGROUND_JOB_IN_PROGRESS_RIBBON", "BP_SCENARIO_APPROVE_BACKGROUND_JOB_IN_PROGRESS_RIBBON", "RP_OPTIMIZATION_SUCCESS_CONTEXT", "RP_OPTIMIZATION_FAILURE_CONTEXT", "RP_OPTIMIZATION_SUCCESS", "RP_OPTIMIZATION_FAILURE", "CP_PROJECTCOSTING_INTRO", "CP_PROJECTCOSTING_FORECAST_COST_OVERWRITE", "CP_PROJECTCOSTING_COPY_PLANNEDBUDGETTOFORECAST", "CP_PROJECTCOSTING_COPY_ACTUALCOSTFROMP6TOACTUALS", "CP_PROJECTCOSTING_COPY_ATCOMPLETIONTOFORECAST", "CP_PROJECTCOSTING_WORKSPACE_INSUFFICIENT_VIEW_PRIVS", "CP_PROJECTCOSTING_WORKSPACE_NO_COST_HOURS_ALLOCATED", "CP_PROJECTCOSTING_INSUFFICIENT_VIEW_PRIVS", "CP_PROJECTCOSTING_NOT_UP_TO_DATE", "CP_PROJECTCOSTING_NOT_UP_TO_DATE_NO_EDIT", "CP_PROJECTCOSTING_COPY_PROPOSEDBUDGETTOPLANNED", "CP_PROJECTCOSTING_COPY_APPROVEDBUDGETTOPLANNED", "CP_INTEGRATION_SOURCE_NOT_SET", "CP_INTEGRATION_SUBCURVE_DATA_ROLLUP", "CP_INTEGRATION_SUMMARY_DATA_IGNORED", "CP_INTEGRATION_SUBCURVE_DATA_IGNORED", "CP_PROJECTSNAPSHOTCOMPARISON_INSUFFICIENT_PRIVS", "CP_SNAPSHOT", "STRATEGY_MEASURE_RECALCULATE_MEASURE_FOR_STRATEGIES_SUCCESFUL", "ANNOTATION_NOTIFY_DOCUMENT_OWNER_ON_ANNOTATION", "ANNOTATION_NOTIFY_DOCUMENT_OWNER_ON_ANNOTATION_WITH_COMMENT", "ANNOTATION_NOTIFY_DOCUMENT_OWNER_ON_DISCUSSION", "ANNOTATION_NOTIFY_DOCUMENT_OWNER_ON_DISCUSSION_WITH_COMMENT", "ANNOTATION_NOTIFY_DOCUMENT_ANNOTATOR_ON_DISCUSSION", "ANNOTATION_NOTIFY_DOCUMENT_ANNOTATOR_ON_DISCUSSION_WITH_COMMENT", "ANNOTATION_NOTIFY_OTHER_COMMENTER_ON_SAME_ANNOTATION", "ANNOTATION_NOTIFY_OTHER_COMMENTER_ON_SAME_ANNOTATION_WITH_COMMENT", "MANUAL_BUDGET_DEFAULT_SUBMIT_COMMENT", "MANUAL_BUDGET_DEFAULT_APPROVE_COMMENT", "MANUAL_BUDGET_DEFAULT_REJECT_COMMENT", "MANUAL_BUDGET_DEFAULT_WITHDRAW_COMMENT", "WORKFLOWS_EMAIL_MESSAGE", "WORKFLOWS_OVERDUE_EMAIL_INSTRUCTIONS", "WORKFLOWS_TASK_OVERDUE_EMAIL_INSTRUCTIONS", "WORKFLOWS_TASK_NOTIFICATION_POPUP_DESC", "WORKFLOWS_TASK_COMPLETED_DESC", "WORKFLOWS_MANUAL_DECISION_TASK_COMPLETED_DESC", "WORKFLOWS_UPDATE_FIELD_TASK_COMPLETED_DESC", "WORKFLOWS_REFRESH_TASK_COMPLETED_DESC", "WORKFLOWS_AUTOMATIC_DECISION_STEP_COMPLETED_DESC", "WORKFLOWS_SERVICES_TASK_COMPLETED_DESC", "WORKFLOWS_SERVICES_TASK_COMPLETED_DESC_COPY_WBS_SERVICE", "WORKFLOWS_SERVICES_TASK_COMPLETED_WITH_ERROR_DESC", "WORKFLOWS_UPDATE_FIELD_CODE_VALUES_DESC", "WORKFLOWS_OVERDUE_TASK_NOTIFICATION_POPUP_DESC", "WORKFLOWS_OVERDUE_NOTIFICATION_POPUP_DESC", "FORM_RESOURCE_ASSIGNMENT_COMPLETED_UI", "FORM_DOCUMENT_UPLOAD_ERROR_MESSAGE", "FORM_FOLDER_CREATION_ERROR_MESSAGE", "FORM_DOCUMENT_FOLDER_ERROR_MESSAGE", "DICTIONARY_ROC_PERCENT_COMPLETE_RANGE_ERROR", "SCOPE_VALIDATION_START_AFTER_FINISH_DATE", "SCOPE_VALIDATION_FINISH_BEFORE_START_DATE", "SCOPE_WPP_SCOPE_ITEM_OVER_ASSIGNED_UNITS", "SCOPE_WPP_NEGATIVE_NUMBER", "SCOPE_WPP_PROGRESS_INSTALLED_UNITS_GREATER_THAN_REVISED", "SCOPE_WPP_PROGRESS_AT_LEAST_ONE_INCREMENT_NOT_ZERO", "SCOPE_WPP_PROGRESS_INSTALLED_CANT_BE_ZERO", "SCOPE_PROJECT_BASELINE_COMPLETED", "SCOPE_PROJECT_BASELINE_COMPLETED_CONTEXT", "SCOPE_PROJECT_BASELINE_REVERT_COMPLETED", "SCOPE_WORK_PACKAGE_ASSIGNMENT_SPREADS_COMPLETED", "SCOPE_WORK_PACKAGE_CURVE_PROFILE_UPDATE_COMPLETED", "SCOPE_WORK_PACKAGE_CURVE_PROFILE_UPDATE_FAILED", "SCOPE_PROJECT_ASSIGNMENT_SPREADS_COMPLETED", "SCOPE_ITEM_CHANGE_DUPLICATE_QUANTITY", "SCOPE_ITEM_CHANGE_DUPLICATE_CBS", "SCOPE_WP_REFRESH_LINK", "SCOPE_ITEM_IMPORT_CELL_VALUE_SET_TO_NULL", "SCOPE_ITEM_IMPORT_UOM_NOT_FOUND", "CHANGE_REQUEST_LINK", "CHANGE_REQUEST_WITHDRAWN_APPROVAL_INBOX", "CHANGE_REQUEST_WITHDRAWN_APPROVAL_HEADER", "CHANGE_REQUEST_REOPENED_REJECTION_INBOX", "CHANGE_REQUEST_REOPENED_REJECTION_HEADER", "CHANGE_REQUEST_ITEM_REOPENED_REJECTION_INBOX", "CHANGE_REQUEST_ITEM_REOPENED_REJECTION_HEADER", "CHANGE_REQUEST_EMAIL_TITLE_WITHDRAW", "CHANGE_REQUEST_EMAIL_TITLE_REOPENED", "WORK_PACKAGE_ASSOCIATION_FOR_PARENT", "SCOPE_WBS_DELETE_WITH_ACTIVITIES_CONFIRM", "SCOPE_BASELINE_EARNED_VALUE_ADD_CONFIRM", "SCOPE_BASELINE_EARNED_VALUE_DELETE_CONFIRM", "SCOPE_BASELINE_IN_PROGRESS_INFO_BANNER", "COPY_WBS", "SYSTEM_ANNOUNCEMENTS_TITLE_REQUIRED", "SYSTEM_ANNOUNCEMENTS_DATE_REQUIRED", "SYSTEM_ANNOUNCEMENTS_TITLE_UNIQUE", "ADMIN_GLOBAL_SECURITY_DELETE_MESSAGE", "WORKFLOWS_STARTWORKFLOW_ALERT_CONTEXT_NOT_DEFINED_MESSAGE", "WORKFLOWS_STARTWORKFLOW_ALERT_HAS_VALIDATION_ERRORS_MESSAGE", "WORKFLOWS_UI_CONTEXT_STARTWORKFLOW_ALERT_CONTEXT_NOT_DEFINED", "WORKFLOWS_UI_CONTEXT_STARTWORKFLOW_ALERT_HAS_PRE_VALIDATION_ERRORS", "WORKFLOWS_UI_CONTEXT_STARTWORKFLOW_ALERT_HAS_VALIDATION_ERRORS", "WORKFLOWS_UI_CONTEXT_STARTWORKFLOW_ALERT_HAS_ERRORS", "FORMS_EDITOR_CONFIRM_CHANGE_FORM_CONTEXT_TYPE", "FORMS_EDITOR_CONFIRM_CHANGE_PICKER_BUSINESS_OBJECT", "FORMS_NEW_VERSION_CREATED", "FORMS_DRAFT_VERSION_CREATED", "FORMS_UNABLE_TO_LOAD", "FORM_SEED_FORM_MISSING_VALIDATION_TITLE", "SEED_FORM_MISSING_VALIDATION_DESCRIPTION", "FORM_VALIDATION_MISSING_MAPPED_FIELD_DESCRIPTION", "WORKFLOWS_VALIDATION_TYPE_WORKFLOW_MANAGER", "WORKFLOWS_VALIDATION_TYPE_TASK_PERFORMER", "WORKFLOWS_VALIDATION_TYPE_SUB_WORKFLOW_MANAGER", "WORKFLOWS_VALIDATION_TYPE_MISSING_STEP", "WORKFLOWS_VALIDATION_TYPE_DUPLICATE_STEP_NAME", "WORKFLOWS_VALIDATION_TYPE_MISSING_TASK", "WORKFLOWS_VALIDATION_TYPE_DUPLICATE_TASK_NAME", "WORKFLOWS_VALIDATION_TYPE_DUPLICATE_EXIT_OPTION_NAME", "WORKFLOWS_VALIDATION_TYPE_MISSING_CONNECTOR_LINE", "WORKFLOWS_VALIDATION_TYPE_ILLEGAL_CONNECTOR_LINE", "WORKFLOWS_VALIDATION_TYPE_CONTEXT_NOT_DEFINED", "WORKFLOWS_VALIDATION_TYPE_CONTEXT_TYPE_MISMATCH", "WORKFLOWS_VALIDATION_TYPE_FORM_TASK", "WORKFLOWS_VALIDATION_TYPE_AUTOMATIC_DECISION_TASK", "WORKFLOWS_VALIDATION_TYPE_MANUAL_DECISION_TASK", "WORKFLOWS_VALIDATION_TYPE_SUB_WORKFLOW_TASK", "WORKFLOWS_VALIDATION_TYPE_UPDATE_FIELD_TASK", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK", "WORKFLOWS_VALIDATION_TYPE_COPY_WBS_SERVICES_TASK", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_BUSINESS_FLOW_NULL", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_INTEGRATION_NULL", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_REPORT_ID_NULL_OR_INACTIVE", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_REPORT_INACTIVE_OR_DELETED", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_REPORT_EMAIL_TO_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_TYPE_SCENARIO_NOT_DEFINED", "WORKFLOWS_VALIDATION_TYPE_CONTEXT_FIELD_MISMATCH", "WORKFLOWS_VALIDATION_TYPE_TASK_DISTRIBUTION", "WORKFLOWS_VALIDATION_TYPE_DURATION", "WORKFLOWS_VALIDATION_EXCEEDED_PORTFOLIO_MAX_LIMIT", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_NOT_IN_LDAP", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_ROLE_PRIMARY_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_NOT_IN_LDAP", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_ROLE_AND_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_ROLE_AND_CONTEXT_NEW_PROJECT", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_ROLE_AND_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_NOT_IN_LDAP", "WORKFLOWS_VALIDATION_DESCRIPTION_INVALID_MANAGER_USER_GROUP", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_ROLE_AND_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_ROLE_AND_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_WITH_NO_STEP", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_WITH_DUPLICATE_STEP_NAME", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_STEP_HAS_NO_TASKS", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_STEP_WITH_DUPLICATE_TASK_NAME", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_WITH_DUPLICATE_EXIT_OPTION_NAME", "WORKFLOWS_VALIDATION_DESCRIPTION_STEP_NOT_CONNECTED_AT_EXIT", "WORKFLOWS_VALIDATION_DESCRIPTION_STEP_NOT_CONNECTED_AT_ENTRY_POINT", "WORKFLOWS_VALIDATION_DESCRIPTION_DECISION_STEP_HAS_ONLY_ONE_EXIT", "WORKFLOWS_VALIDATION_DESCRIPTION_START_STEP_CONNECTED_AT_ENTRY_POINT", "WORKFLOWS_VALIDATION_DESCRIPTION_FINAL_STEP_UNREACHABLE", "WORKFLOWS_VALIDATION_DESCRIPTION_START_STEP_NOT_CONNECTED", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_STEP_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_STEP_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_CONTEXT_SAME_AS_SUB_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_FORM_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_FORM_FIELD_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_FORM_NEW", "WORKFLOWS_VALIDATION_DESCRIPTION_FORM_DISABLED", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_FIELD_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_NO_VALUE_DEFINED_FOR_OPTION", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_VALUE_LEADS_TO_MORE_THAN_ONE_OPTION", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_CONDITIONS_NOT_FULLY_DEFINED", "WORKFLOWS_VALIDATION_DESCRIPTION_MANUAL_DECISION_MISSING_QUESTION", "WORKFLOWS_VALIDATION_DESCRIPTION_MANUAL_DECISION_MISSING_NAME", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_DISABLED", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_VALUE_NOT_DEFINED", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_DATE_FIELD_VALUE_NOT_DEFINED", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_DATE_LOOKUP_FIELD_VALUE_NOT_DEFINED", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_SCENARIO_AND_CONTEXT_CP", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_SCENARIO_AND_CONTEXT_SAME_AS_WORKFLOW_CP", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_FIELD_SCENARIO_AND_CONTEXT_CP", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_FIELD_SCENARIO_AND_CONTEXT_SANE_AS_WORKFLOW_CP", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_CONTEXT_SAME_AS_WORKFLOW_CP_AND_DISTRIBUTION_SCENARIOS", "WORKFLOWS_VALIDATION_DESCRIPTION_FIRST_STEP_NOT_PREASSIGNED", "WORKFLOWS_VALIDATION_DESCRIPTION_STEP_FROM_AUTMATIC_DECISION_NOT_PREASSIGNED", "WORKFLOWS_VALIDATION_DESCRIPTION_EXCEEDED_PORTFOLIO_MAX_LIMIT", "WORKFLOWS_OVERRIDE_TASK", "WORKFLOWS_TASK_OVERRIDE", "WORKFLOWS_VALIDATION_DESCRIPTION_INVALID_NEWPROJECTFORM", "WORKFLOWS_VALIDATION_SERVICE_TASK_TYPE_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_CONF_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_INTEGRATION_TYPE_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_P6_EPPM_CONFIGURATION_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_P6_EPPM_BUSINESS_FLOW_ID_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_PRIMAVERA_GATEWAY_INTEGRATION_ID_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_INTEGRATION_TYPE_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_RECALCULATE_COST_CONF_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_RECALCULATE_COST_SCENARIO_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_REPORT_CONF_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_REPORT_ID_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_REPORT_INACTIVE_OR_DELETED", "WORKFLOWS_VALIDATION_SERVICE_TASK_REPORT_CONFIGURED_EMAIL_TO_USERS_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_COPY_WBS_CONF_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_SOURCE_WBS_ID_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_TARGET_WBS_ID_NULL", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_WORKFLOW_MANAGER", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_CONTEXT_FIELD_MISMATCH", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_TASK_DISTRIBUTION", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_SUB_WORKFLOW_TASK", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_FORM_TASK", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_NOT_IN_LDAP", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_NO_MANAGER_ERROR", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_NOT_VALID_WITHOUT_CONTEXT", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_UPDATE_FIELD_CONTEXT_CP_AND_UPDATE_FIELD_SCENARIO", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_AUTOMATIC_CONDITION_CONTEXT_CP_AND_CONDITION_FIELD_SCENARIO", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_TASK_CONTEXT_SCENARIO_AND_DISTRIBUTION_SCENARIOS", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_SUB_WORKFLOW_DISABLED", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_FORM_DISABLED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_STARTED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_STOPPED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_COMPLETED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_CONTEXT_DEFINED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_ARCHIVED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_ABORTED", "WORKFLOWS_REPORT_EVENT_TYPE_STEP_STARTED", "WORKFLOWS_REPORT_EVENT_TYPE_AUTOMATIC_DECISION_STEP_EXECUTED", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_INSTANTIATED", "WORKFLOWS_REPORT_EVENT_TYPE_NO_TASKS_INSTANTIATED", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_REASSIGNED", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_COMPLETED", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_COMPLETED_BY_MANAGER", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_EXECUTED", "WORKFLOW_INSTANCE_STATUS_EXECUTING", "WORKFLOW_INSTANCE_STATUS_STOPPED", "WORKFLOW_INSTANCE_STATUS_HALTED", "WORKFLOW_INSTANCE_STATUS_PENDING", "WORKFLOW_INSTANCE_STATUS_FINISHED", "WORKFLOWS_REPORT_WORKFLOW", "WORKFLOWS_REPORT_CONTEXT_B", "WORKFLOWS_REPORT_CONTEXT_STEP", "WORKFLOWS_REPORT_CONTEXT_TASK", "WORKFLOWS_REPORT_CONTEXT_NULL", "WORKFLOWS_REPORT_CONTEXT_CAPITAL_PLAN", "WORKFLOWS_REPORT_CONTEXT_CAPITAL_PLAN_SCENARIO", "WORKFLOWS_REPORT_CONTEXT_CAPITAL_PLAN_PROJECT", "WORKFLOWS_REPORT_CONTEXT_CAPITAL_PLAN_SCENARIO_PROJECT", "WORKFLOWS_REPORT_CONTEXT_PROJECT", "WORKFLOWS_REPORT_CONTEXT_NEW_PROJECT", "WORKFLOWS_REPORT_CONTEXT_CONTRACT", "WORKFLOWS_REPORT_CONTEXT_COMMITMENT", "WORKFLOWS_REPORT_CONTEXT_BUDGET", "WORKFLOWS_REPORT_CONTEXT_NOT_DEFINED", "WORKFLOWS_REPORT_MANAGER", "WORKFLOWS_REPORT_STARTED_BY", "WORKFLOWS_REPORT_STOPPED_IN_STEP", "WORKFLOWS_REPORT_SUB_WORKFLOW", "WORKFLOWS_REPORT_BY", "WORKFLOWS_REPORT_NEW_CONTEXT", "WORKFLOWS_REPORT_STEP", "WORKFLOWS_REPORT_TASK", "WORKFLOWS_REPORT_ARCHIVED_BY", "WORKFLOWS_REPORT_DECISION_OPTION_SELECTED", "WORKFLOWS_REPORT_FORM", "WORKFLOWS_REPORT_PERFORMER", "WORKFLOWS_REPORT_NEW_PERFORMER", "WORKFLOWS_REPORT_PERFORMER_INITIATOR", "WORKFLOWS_REPORT_MANUAL_DECISION", "WORKFLOWS_REPORT_NONE", "WORKFLOWS_REPORT_DECISION_TYPE", "WORKFLOWS_REPORT_DECISION_TASKS_SENT", "WORKFLOWS_REPORT_UPDATED_BY_SYSTEM", "WORKFLOWS_REPORT_UPDATE_FIELD", "WORKFLOWS_REPORT_SUB_WORKFLOW_B", "WORKFLOWS_REPORT_SYNCHRONOUS", "WORKFLOWS_REPORT_ASYNCHRONOUS", "WORKFLOWS_REPORT_SUB_WORKFLOW_MANAGER", "WORKFLOWS_REPORT_SUB_WORKFLOW_MANAGER_INITIATOR", "WORKFLOWS_REPORT_WORKFLOW_ABORTED_DUE_TO_ERROR", "WORKFLOWS_REPORT_SYNCHRONOUS_SUB_WORKFLOW_STOPPED", "WORKFLOWS_REPORT_SYNCHRONOUS_SUB_WORKFLOW_FAULTED", "WORKFLOWS_REPORT_IN", "WORKFLOWS_REPORT_FAILED_IN", "WORKFLOWS_REPORT_TASK_B", "WORKFLOWS_REPORT_FORM_B", "WORKFLOWS_REPORT_MANUAL_DECISION_B", "WORKFLOWS_REPORT_UPDATE_FIELD_B", "WORKFLOWS_REPORT_PORTFOLIO_REFRESH_B", "WORKFLOW_REPORT_SERVICES_B", "WORKFLOWS_REPORT_SUB_WORKFLOW_C", "WORKFLOWS_REPORT_COMPLETED_BY_MANAGER", "WORKFLOWS_REPORT_ERROR", "WORKFLOWS_REPORT_REASON", "WORKFLOWS_REPORT_WARNING", "WORKFLOWS_REPORT_AUTOMATIC_DECISION", "WORKFLOWS_REPORT_ERROR_IN_SUB_WORKFLOW", "WORKFLOWS_REPORT_SUB_WORKFLOW_DISABLED", "WORKFLOWS_REPORT_SUB_WORKFLOW_CONTAINS_VALIDATION_ERRORS", "WORKFLOWS_REPORT_SUB_WORKFLOW_CONTAINS_PRE_EXECUTION_VALIDATION_ERRORS", "WORKFLOWS_REPORT_SUB_WORKFLOW_RECURSION_LIMIT_EXCEEDED", "WORKFLOWS_REPORT_CONTEXT_TYPE_OF_START_SUB_WORKFLOW_DIFFERS", "WORKFLOWS_REPORT_ERROR_IN_FORM", "WORKFLOWS_REPORT_FORM_DISABLED", "WORKFLOWS_REPORT_CONTEXT_TYPE_OF_FORM_DIFFERS", "WORKFLOWS_REPORT_PROJECT", "WORKFLOWS_REPORT_FORM_DOES_NOT_SUPPORT_CREATION_OF_A_NEW", "WORKFLOWS_REPORT_MANAGER_OF_SUB_WORKFLOW_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PERFORMER_OF_FORM_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PERFORMER_OF_MANUAL_DECISION_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PERFORMER_OF_UPDATE_FIELD_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PERFORMER_OF_SERVICES_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PROJECT_CODE_NOT_RESOLVED", "WORKFLOWS_REPORT_UPDATE_VALUE_CODE_NOT_RESOLVED", "WORKFLOWS_REPORT_UPDATE_VALUE_CODE_NOT_FOUND", "WORKFLOWS_REPORT_UPDATE_USER_FIELD_NOT_FOUND", "WORKFLOWS_REPORT_PORTFOLIO_NOT_FOUND", "WORKFLOWS_REPORT_UPDATE_VALUE_LIST_UDF_NOT_FOUND", "WORKFLOWS_REPORT_UPDATE_VALUE_UDF_DISABLED", "WORKFLOWS_REPORT_NO_TASKS_GENERATED_FOR_STEP", "WORKFLOWS_REPORT_SYSTEM_UPDATED_ON_BEHALF", "WORKFLOWS_REPORT_RFI", "WORKFLOWS_REPORT_IDEA", "WORKFLOWS_REPORT_PROGRAM", "MONITOR_WORKFLOW_EVENT_NAME_WITH_PREFIX", "MONITOR_WORKFLOW_EVENT_NOT_AVAILABLE", "ERRONEOUS_WORKFLOW_PROPOSE_RISK_ERROR_TITLE", "DOCUMENT_DELETE_CONFIRMATION", "DOCUMENT_UNLINK_CONFIRMATION", "DOCUMENTS_EXTENSION_ERROR", "DOCUMENT_ADD_SECURITY_MESSAGE", "DOCUMENT_LINK_SECURITY_MESSAGE", "DOCUMENTS_TEMPLATE_COPY_NOTIFICATION_SHORT", "DOCUMENTS_TEMPLATE_COPY_NOTIFICATION", "DOCUMENTS_TEMPLATE_COPY_ERROR_SHORT", "DOCUMENTS_TEMPLATE_COPY_ERROR", "PROJECT_DOCUMENTS_COPY_NOTIFICATION", "PROJECT_DOCUMENTS_COPY_ERROR", "DOCUMENTS_VIRUSSCAN_FAILED_NOTIFICATION_SHORT", "DOCUMENTS_VIRUSSCAN_FAILED_NOTIFICATION", "DOCUMENTS_VIRUSSCAN_INCONCLUSIVE_NOTIFICATION_SHORT", "DOCUMENTS_VIRUSSCAN_INCONCLUSIVE_NOTIFICATION", "DOCUMENTS_VIRUSSCAN_ERROR_NOTIFICATION_SHORT", "DOCUMENTS_VIRUSSCAN_ERROR_NOTIFICATION", "DOCUMENTS_VIRUSSCAN_SUCCESS_NOTIFICATION_SHORT", "DOCUMENTS_VIRUSSCAN_SUCCESS_NOTIFICATION", "DOCUMENTS_VIRUSSCAN_STATUS_PENDING", "DOCUMENTS_VIRUSSCAN_STATUS_CLEARED", "DOCUMENTS_VIRUSSCAN_STATUS_FAILED", "DOCUMENTS_VIRUSSCAN_STATUS_INCONCLUSIVE", "DOCUMENTS_VIRUSSCAN_STATUS_ERROR", "REPORT_NOTIFY_INACTIVE_REPORT_NOT_RUN_LONG", "REPORT_NOTIFY_READY_TO_VIEW", "REPORT_NOTIFY_CANNOT_GENERATE_REPORT", "REPORT_ERROR_UNABLE_TO_LOAD_LAYOUTS", "REPORT_DATA_EXCEED_LIMIT_EMAIL_INSTRUCTIONS", "REPORT_ACCESSIBILITY_CONTEXT", "SINGLE_RECORD_PRINT_TIMEOUT_REPORT_RUNNING_IN_BACKGROUND", "SINGLE_RECORD_PRINT_REPORT_RUNNING_IN_BACKGROUND", "SINGLE_RECORD_PRINT_NOTIFY_READY_TO_VIEW", "SERVICE_PROFILEMIGRATION_GLOBAL_STAGE", "SERVICE_PROFILEMGIRATION_GLOBAL_START", "SERVICE_PROFILEMIGRATION_USERS_NOTFOUND", "SERVICE_PROFILEMIGRATION_USERS_FOUND", "SERVICE_PROFILEMIGRATION_GLOBAL_SUPERUSER", "SERVICE_PROFILEMIGRATION_GLOBAL_SUCCESS_NOUSERS", "SERVICE_PROFILEMIGRATION_SUCCESS", "SERVICE_PROFILEMIGRATION_COMPLETE", "SERVICE_PROFILEMIGRATION_PROJECT_STAGE", "SERVICE_PROFILEMGIRATION_PROJECT_START", "SERVICE_PROFILEMGIRATION_PROJECT_NOPROJECT", "SERVICE_PROFILEMGIRATION_PROJECT_NOUSERS", "SERVICE_PROFILEMGIRATION_PROJECT_FOUND", "SERVICE_PROFILEMIGRATION_PROJECT_GROUP", "CBS_CONFIRM_DIALOG_WS_SAVE", "CBS_DETAILS_SAVE_ALERT", "CBS_IMPORT_NO_CODES_TO_IMPORT", "CBS_RECALCULATE_COST_FAILED_CONTEXT", "CBS_RECALCULATE_COST_SUCCESS", "CBS_RECALCULATE_COST_SUCCESS_CONTEXT", "CBS_RECALCULATE_COST_WORKSPACE_FAILED_CONTEXT", "CBS_RECALCULATE_COST_WORKSPACE_SUCCESS", "CBS_RECALCULATE_COST_WORKSPACE_SUCCESS_CONTEXT", "CBS_RECALCULATE_COST_PROGRAM_SUCCESS", "CBS_RECALCULATE_COST_PROGRAM_SUCCESS_CONTEXT", "PROGRAM_CALCULATE_PROGRAM_PROJECT_CURVES_COSTS_FAILED_CONTEXT", "PROGRAM_CALCULATE_PROGRAM_PROJECT_CURVES_COSTS_SUCCESS", "PROGRAM_CALCULATE_PROGRAM_PROJECT_CURVES_COSTS_SUCCESS_CONTEXT", "CBS_RECALCULATE_COST_VIEW_SHEET", "PROGRAM_CALCULATE_COST_CURVE_VIEW", "ROLES_REFRESH_LINK", "PROJECT_BUDGET_NO_CBS_CODES_WITH_CREATE_PRIVILEGE", "PROJECT_BUDGET_LINK", "PROJECT_BUDGET_SUBMIT_DIALOG_COMMENT", "PROJECT_BUDGET_SUBMIT_DIALOG_INBOX", "PROJECT_BUDGET_SUBMIT_DIALOG_HEADER", "PROJECT_BUDGET_REJECT_DIALOG_COMMENT", "PROJECT_BUDGET_REJECT_DIALOG_INBOX", "PROJECT_BUDGET_REJECT_DIALOG_HEADER", "PROJECT_BUDGET_APPROVAL_DIALOG_COMMENT", "PROJECT_BUDGET_APPROVAL_DIALOG_INBOX", "PROJECT_BUDGET_APPROVAL_DIALOG_HEADER", "PROJECT_BUDGET_WITHDRAW_APPROVAL_DIALOG_COMMENT", "PROJECT_BUDGET_WITHDRAW_APPROVAL_DIALOG_INBOX", "PROJECT_BUDGET_WITHDRAW_APPROVAL_DIALOG_HEADER", "PROJECT_BUDGET_EXCEL_NOTIFICATION_REFRESH_LINK", "BUDGET_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "BUDGET_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "BUDGET_STATUS_CHANGE_EMAIL_TITLE_REJECT", "BUDGET_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "BUDGET_CHANGE_LINK", "BUDGET_CHANGE_SUBMIT_DIALOG_COMMENT", "BUDGET_CHANGE_SUBMIT_DIALOG_INBOX", "BUDGET_CHANGE_SUBMIT_DIALOG_HEADER", "BUDGET_CHANGE_REJECT_DIALOG_COMMENT", "BUDGET_CHANGE_REJECT_DIALOG_INBOX", "BUDGET_CHANGE_REJECT_DIALOG_HEADER", "BUDGET_CHANGE_APPROVAL_DIALOG_COMMENT", "BUDGET_CHANGE_APPROVAL_DIALOG_INBOX", "BUDGET_CHANGE_APPROVAL_DIALOG_HEADER", "BUDGET_CHANGE_WITHDRAW_APPROVAL_DIALOG_COMMENT", "BUDGET_CHANGE_WITHDRAW_APPROVAL_DIALOG_INBOX", "BUDGET_CHANGE_WITHDRAW_APPROVAL_DIALOG_HEADER", "BUDGET_CHANGE_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "BUDGET_CHANGE_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "BUDGET_CHANGE_STATUS_CHANGE_EMAIL_TITLE_REJECT", "BUDGET_CHANGE_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "BUDGET_TRANSFER_LINK", "BUDGET_TRANSFER_SUBMIT_DIALOG_COMMENT", "BUDGET_TRANSFER_SUBMIT_DIALOG_INBOX", "BUDGET_TRANSFER_SUBMIT_DIALOG_HEADER", "BUDGET_TRANSFER_REJECT_DIALOG_COMMENT", "BUDGET_TRANSFER_REJECT_DIALOG_INBOX", "BUDGET_TRANSFER_REJECT_DIALOG_HEADER", "BUDGET_TRANSFER_APPROVAL_DIALOG_COMMENT", "BUDGET_TRANSFER_APPROVAL_DIALOG_INBOX", "BUDGET_TRANSFER_APPROVAL_DIALOG_HEADER", "BUDGET_TRANSFER_WITHDRAW_APPROVAL_DIALOG_COMMENT", "BUDGET_TRANSFER_WITHDRAW_APPROVAL_DIALOG_INBOX", "BUDGET_TRANSFER_WITHDRAW_APPROVAL_DIALOG_HEADER", "BUDGET_TRANSFER_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "BUDGET_TRANSFER_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "BUDGET_TRANSFER_STATUS_CHANGE_EMAIL_TITLE_REJECT", "BUDGET_TRANSFER_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "BUDGET_SUBMIT_DIALOG_COMMENT", "BUDGET_SUBMIT_DIALOG_INBOX", "BUDGET_SUBMIT_DIALOG_HEADER", "BUDGET_REJECT_DIALOG_COMMENT", "BUDGET_REJECT_DIALOG_INBOX", "BUDGET_REJECT_DIALOG_HEADER", "BUDGET_APPROVAL_DIALOG_COMMENT", "BUDGET_APPROVAL_DIALOG_INBOX", "BUDGET_APPROVAL_DIALOG_HEADER", "BUDGET_WITHDRAW_APPROVAL_DIALOG_COMMENT", "BUDGET_WITHDRAW_APPROVAL_DIALOG_INBOX", "BUDGET_WITHDRAW_APPROVAL_DIALOG_HEADER", "BUDGET_EXCEL_NOTIFICATION_REFRESH_LINK", "PROGRAM_BUDGET_LINK", "PRIMARY_PROGRAM_HELP_TEXT", "SCENARIO_VIEW_LINK", "PROJECT_ACTUALS_TOTAL_MUST_NOT_BE_ZERO", "PROJECT_ACTUALS_WITHDRAW_CONFIRMATION", "PROJECT_ACTUALS_REFRESH_LINK", "PROJECT_ACTUALS_INVALIDEXCHANGERATE", "PROJECT_CASCADE_DELETE_NOTIFY_SUCCESSFUL", "PROJECT_CASCADE_DELETE_NOTIFY_SUCCESSFUL_DESCRIPTION", "PROJECT_CASCADE_DELETE_NOTIFY_INCOMPLETE", "PROJECT_CASCADE_DELETE_NOTIFY_INCOMPLETE_DESCRIPTION", "PROJECT_CASCADE_DELETE_NOTIFY_FAILED", "PROJECT_CASCADE_DELETE_NOTIFY_FAILED_DESCRIPTION", "SCHEDULER_FAILED_PROJECT_ERROR_CONTEXT", "SCHEDULER_FAILED_PROJECT_SCENARIO_ERROR_CONTEXT", "SCHEDULER_FAILED_PROGRAM_ERROR_CONTEXT", "SCHEDULER_FAILED_MULTIPLE_PROJECTS_ERROR_CONTEXT", "SCHEDULER_FAILED_PORTFOLIO_ERROR_CONTEXT", "SCHEDULER_PROJECT_SUCCESS", "SCHEDULER_PROJECT_SCENARIO_SUCCESS", "SCHEDULER_PORTFOLIO_SUCCESS", "SCHEDULER_PROGRAM_SUCCESS", "SCHEDULER_PROJECT_SUCCESS_CONTEXT", "SCHEDULER_PROJECT_SCENARIO_SUCCESS_CONTEXT", "SCHEDULER_PORTFOLIO_SUCCESS_CONTEXT", "SCHEDULER_PROGRAM_SUCCESS_CONTEXT", "SCHEDULER_MULTIPLE_PROJECTS_SUCCESS_CONTEXT", "SCHEDULER_LOG_AUTO_RECALCULATE_COST_IN_PROGRAM", "SCHEDULER_LOG_AUTO_RECALCULATE_COST_WITHOUT_PRIVILEGE", "FUNCTION_FULL_RECALC_CYCLE_COMPLETED", "FUNCTION_FULL_RECALC_CYCLE_COMPLETED_DESC", "FUNCTION_FULL_RECALC_CYCLE_FAILED", "FUNCTION_FULL_RECALC_CYCLE_FAILED_DESC", "FUNCTION_FULL_RECALC_CYCLE_STARTED", "FUNCTION_FULL_RECALC_CYCLE_STARTED_DESC", "FUNCTION_AUTO_RECALC_FOR_BASELINE_ACTION", "FUNCTION_AUTO_RECALC_FOR_BASELINE_ACTION_DESC", "FUNCTION_RECALC_POST_IMPORT_JOB_COMPLETED", "FUNCTION_RECALC_POST_IMPORT_JOB_COMPLETED_DESC", "FUNCTION_RECALC_POST_IMPORT_JOB_COMPLETED_WITH_ERRORS", "FUNCTION_RECALC_POST_IMPORT_JOB_COMPLETED_WITH_ERRORS_DESC", "FUNCTION_RECALC_POST_IMPORT_JOB_FAILED", "FUNCTION_RECALC_POST_IMPORT_JOB_FAILED_DESC", "RECALCULATE_SCHEDULE_COST_FAILED_PROJECT_ERROR_CONTEXT", "RECALCULATE_SCHEDULE_COST_FAILED_PROJECT_SCENARIO_ERROR_CONTEXT", "RECALCULATE_SCHEDULE_COST_FAILED_PORTFOLIO_ERROR_CONTEXT", "RECALCULATE_SCHEDULE_COST_FAILED_PROGRAM_ERROR_CONTEXT", "RECALCULATE_SCHEDULE_COST_PROJECT_SUCCESS", "RECALCULATE_SCHEDULE_COST_PROJECT_SCENARIO_SUCCESS", "RECALCULATE_SCHEDULE_COST_PORTFOLIO_SUCCESS", "RECALCULATE_SCHEDULE_COST_PROGRAM_SUCCESS", "RECALCULATE_SCHEDULE_COST_FAILED_SECURITY_LOG_DETAILS", "CBS_SYNC_SUCCESS", "CBS_SYNC_VIEW_LINK", "CBS_SYNC_FAILED_PROJECT_ERROR_CONTEXT", "CBS_SYNC_FAILED_CONTEXT", "CBS_SYNC_SUCCESS_LOG", "CALCULATE_PROJECT_SPREADS_SUCCESS", "CALCULATE_PROJECT_SPREADS_SUCCESS_CONTEXT", "CALCULATE_PROJECT_SPREADS_FAILED_ERROR_CONTEXT", "CALCULATE_SPREADS_FAILED_ERROR_PREFIX", "CALCULATE_SPREADS_REQUEST_SETTINGS_ERROR", "CALCULATE_ASSIGNMENT_SPREADS_REQUEST_DETAILS_HEADER_SUCCESS", "CALCULATE_ASSIGNMENT_SPREADS_REQUEST_DETAILS_HEADER_FAILED", "CALCULATE_ASSIGNMENT_SPREADS_REQUEST_DETAILS_HEADER_WARNING", "CALCULATE_SPREADS_COST_ITEMS_IGNORED_WARNING", "LEVELER_FAILED_PROJECT_ERROR_CONTEXT", "LEVELER_FAILED_PROJECT_SCENARIO_ERROR_CONTEXT", "LEVELER_UNABLE_TO_RUN_ERROR_CONTEXT", "LEVELER_SUCCESS", "LEVELER_SCENARIO_SUCCESS", "LEVELER_SUCCESS_CONTEXT", "LEVELER_SCENARIO_SUCCESS_CONTEXT", "VIEW_ACTIVITIES_LINK", "RUN_GLOBAL_CHANGE_PROJECT_SUCCESS", "RUN_GLOBAL_CHANGE_PROJECT_SUCCESS_SCENARIO", "RUN_GLOBAL_CHANGE_PROJECT_SUMMARY", "RUN_GLOBAL_CHANGE_PROJECT_SUMMARY_SCENARIO", "RUN_GLOBAL_CHANGE_PROJECT_SUMMARY_FAILED_NO_RECORD", "RUN_GLOBAL_CHANGE_PROJECT_FAILED", "RUN_GLOBAL_CHANGE_PROJECT_FAILED_SCENARIO", "RUN_GLOBAL_CHANGE_PROJECT_FAILED_NO_RECORD", "GET_GLOBAL_CHANGE_FAILED_COPY", "STORE_PERIOD_PROJECT_SUCCESS_CONTEXT", "STORE_PERIOD_PROJECT_SUCCESS", "STORE_PERIOD_NO_LAST_PERIOD", "STORE_PERIOD_PROJECT_FAILED", "RUN_STORE_PERIOD_PROJECT_SUMMARY", "STORE_PERIOD_FAILED_NO_RECORD", "STORE_PERIOD_SECURITY_FAILURE_LOG", "APPLY_ACT_UNCERTAINTY_FAILED_PROJECT_ERROR_CONTEXT", "APPLY_ACT_UNCERTAINTY_FAILED_PORTFOLIO_ERROR_CONTEXT", "APPLY_ACT_UNCERTAINTY_PROJECT_SUCCESS", "APPLY_ACT_UNCERTAINTY_PORTFOLIO_SUCCESS", "APPLY_ACT_UNCERTAINTY_PROJECT_SCENARIO_SUCCESS", "APPLY_ACT_UNCERTAINTY_FAILED_PROJECT_SCENARIO_ERROR_CONTEXT", "APPLY_ACT_UNCERTAINTY_PROGRAM_SUCCESS", "APPLY_ACT_UNCERTAINTY_FAILED_PROGRAM_ERROR_CONTEXT", "RISK_ANALYSIS_UNABLE_TO_RUN_ERROR_CONTEXT", "RISK_ANALYSIS_NO_POST_DATA_ERROR_CONTEXT", "RISK_ANALYSIS_FAILED_ERROR_CONTEXT", "RISK_ANALYSIS_COMPLETED_PRE", "RISK_ANALYSIS_COMPLETED_PRE_CONTEXT", "RISK_ANALYSIS_COMPLETED_POST", "RISK_ANALYSIS_COMPLETED_POST_CONTEXT", "RISK_ANALYSIS_COMPLETED_SENSITIVITY", "RISK_ANALYSIS_COMPLETED_SENSITIVITY_CONTEXT", "RISK_ANALYSIS_COMPLETED", "RISK_ANALYSIS_COMPLETED_CONTEXT", "RISK_REGISTER_NO_VIEW_PRIVILEGES", "RISK_MATRIX_JOB_TRIGGERED", "RISK_ANALYSIS_SCATTER_PLOT_CONFIRM_SAVE_TARGET", "RISK_ANALYSIS_SCATTER_PLOT_NOT_AVAILABLE", "RISK_QUANTIFIED_IMPACT_CALCULATION_FAILED", "RISK_QUANTIFIED_IMPACT_CALCULATION_FAILED_CONTEXT", "RISK_QUANTIFIED_IMPACT_CALCULATION_SUCCESSFUL", "RISK_QUANTIFIED_IMPACT_CALCULATION_SUCCESSFUL_CONTEXT", "MC_WEATHER_RUN_IN_PROGRESS", "MC_WEATHER_RUN_FAILED", "MC_WEATHER_RUN_COMPLETED", "MC_WEATHER_RUN_IN_PROGRESS_CONTEXT", "MC_WEATHER_RUN_FAILED_CONTEXT", "MC_WEATHER_RUN_COMPLETED_CONTEXT", "RISK_SCORING_MATRICES_THRESHOLD_CHANGE_WITH_RISKS", "RISK_SCORING_MATRICES_USER_CHANGED", "RISK_SCORING_MATRICES_CHANGE_SCORE_METHOD", "RISK_REGISTER_ASSIGN_MATRIX_SUCCESSFUL", "RISK_REGISTER_ASSIGN_MATRIX_FAILED", "RISK_REGISTER_REMOVE_MATRIX", "RISK_EXCEL_NOTIFICATION_REFRESH_LINK", "GATEWAY_NOTIFICATION_SHORT_DESC_STARTED", "GATEWAY_NOTIFICATION_SHORT_DESC_COMPLETED", "GATEWAY_NOTIFICATION_SHORT_DESC_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_SHORT_DESC_FAILED", "GATEWAY_NOTIFICATION_SHORT_DESC_IMPORT_COMPLETED", "GATEWAY_NOTIFICATION_SHORT_DESC_IMPORT_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_SHORT_DESC_IMPORT_FAILED", "GATEWAY_NOTIFICATION_MESSAGE_SYNCHRONIZATION_STARTED", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_COMPLETED", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_FAILED", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_COMPLETED", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_FAILED", "GATEWAY_NOTIFICATION_MESSAGE_MASTER_DATA_STARTED", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_MASTER_DATA_COMPLETED", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_MASTER_DATA_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_MASTER_DATA_FAILED", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_MASTER_DATA_COMPLETED", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_MASTER_DATA_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_MASTER_DATA_FAILED", "CHARTS_EMPTY_STATE_MESSAGE", "CHARTS_EMPTY_STATE_MESSAGE_VIEW_ONLY", "SM_CONFIRM_CONVERT_TO_SUMMARY_ACTIVITY", "SM_CONFIRM_CONVERT_TO_WBS_SUMMARY_ACTIVITY", "SM_CONFIRM_CHANGE_ACTIVITY_STATUS_TO_TK_NOTSTART_VALIDATION", "SM_PRE_RESPONSE_NAME_STRING", "SM_POST_RESPONSE_NAME_STRING", "SM_RECALCULATE_SCHEDULE_HEALTH_VIEW", "SM_RECALCULATE_SCHEDULE_HEALTH_FAILED_CONTEXT", "SM_RECALCULATE_SCHEDULE_HEALTH_SUCCESS", "SM_RECALCULATE_SCHEDULE_HEALTH_SUCCESS_CONTEXT", "SM_SCHEDULE_WAIT_CURRENT", "SM_SCHEDULE_WAIT_CURRENT_PROCESS", "SM_BASELINE_SET_CURRENT_SCHEDULE", "SM_REMOVE_ALL_LABOR_NONLABOR_COSTS", "SM_REMOVE_ALL_LABOR_NONLABOR_COSTS_PLURAL", "SM_CONFIRM_ACTIVITY_DELETE", "SM_PERIOD_PERFORMANCE_CHANGE_TO_NOT_STARTED_WITH_SPP_DATA", "SM_COPY_ACTIVITY_FILE_FAILED", "SM_COPY_ACTIVITY_FILE_FAILED_WITH_FILE_MICROSERVICE_DOWN", "SM_PAGE_LOAD_BASELINE_MESSAGE", "SM_PAGE_LOAD_SCENARIO_MESSAGE", "SCENARIO_CREATE_FAILED_CONTEXT", "BASELINE_CREATE_FAILED_CONTEXT", "BASELINE_REVERT_FAILED_CONTEXT", "SM_SCHEDULE_SCENARIOS_IN_PROGRESS_INFO_BANNER", "SM_RELATED_ACTIVITY_HELP", "SM_GOTO_EXTERNAL_ACTIVITY", "SCHEDULE_HEALTH_SETTINGS_SUCCESS", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_SINGLE_WORKSPACE_SUCCESS_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_MULTIPLE_WORKSPACES_SUCCESS_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_SINGLE_PROJECT_SUCCESS_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_MULTIPLE_PROJECTS_SUCCESS_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_FAIL", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_WORKSPACES_FAIL_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_PROJECTS_FAIL_MESSAGE", "LN_RECALCULATE_TASK_SUMMARY_CHECK_VIEW", "LN_RECALCULATE_TASK_SUMMARY_CHECK_FAILED_CONTEXT", "LN_RECALCULATE_TASK_SUMMARY_CHECK_WAITING_CONTEXT", "LN_RECALCULATE_TASK_SUMMARY_CHECK_WAITING_MESSAGE", "LN_RECALCULATE_TASK_SUMMARY_CHECK_UI_ERROR_CONTEXT", "LN_RECALCULATE_TASK_SUMMARY_CHECK_SUCCESS", "LN_RECALCULATE_TASK_SUMMARY_CHECK_SUCCESS_CONTEXT", "REPLACE_RESOURCE_SUCCESS_CONTEXT", "REPLACE_RESOURCE_SUCCESS_DESCRIPTION", "REPLACE_RESOURCE_FAILED_ERROR_CONTEXT", "REPLACE_RESOURCE_FAILED_ERROR_DESCRIPTION", "REPLACE_RESOURCE_SUCCESS_LOG", "REPLACE_RESOURCE_ERROR_LOG", "REPLACE_RESOURCE_FAILED", "WORK_RATE_SYNC_SUCCESS", "WORK_RATE_SYNC_TENANT_ERROR", "WORK_RATE_SYNC_WORKSPACE_ERROR", "LN_TASK_NOTIFICATION_FOR_PROPOSED_DUE_DATE_CONTEXT", "LN_TASK_NOTIFICATION_FOR_OVERDUE_CONTEXT", "LN_TASK_NOTIFICATION_FOR_PROPOSED_DUE_DATE", "LN_TASK_NOTIFICATION_FOR_OVERDUE", "LN_TASK_NOTIFICATION_FOR_PROPOSED_DUE_DATE_DESCRIPTION", "SET_ACTIVITY_SCENARIO_SUCCESS", "SET_ACTIVITY_SCENARIO_FAILURE", "SET_ACTIVITY_SCENARIO_SUCCESS_CONTEXT", "SET_ACTIVITY_SCENARIO_FAILURE_CONTEXT", "SCENARIO_CREATE_SUCCESS", "SCENARIO_CREATE_SUCCESS_CONTEXT", "SET_ACTIVITY_SCENARIO_MERGE_INPROGRESS", "MERGE_COMPLETED_SUCCESSFULLY_NOTIFY_DETAIL", "MERGE_COMPLETED_SUCCESSFULLY_SUMMARY", "MERGE_COMPLETED_SUCCESSFULLY_INBOX_DETAIL", "SCHEDULE_MERGE_COMPLETE_SUCCESS", "UNABLE_TO_COMPLETE_MERGE", "MERGE_FAILED_NOTIFY_MSG", "MERGE_FAILED_INBOX_MSG", "SCHEDULE_MERGE_ACTIVITY_UNIQUE_CODE_VIOLATION", "PARTNERUSER_CREATE_USER_SUCCESS", "PARTNERUSER_PASSWD_CHANGE_SUCCESS", "COMPANY_USER_EXISTS", "PR_ERROR_FINISH_BEFORE_START", "SU_EMAIL_INSTRUTIONS", "TM_ERROR_NO_TASKS_FOUND", "CONTRACT_LINK", "CONTRACT_SUBMIT_DIALOG_COMMENT", "CONTRACT_SUBMIT_DIALOG_INBOX", "CONTRACT_SUBMIT_DIALOG_HEADER", "CONTRACT_REJECT_DIALOG_COMMENT", "CONTRACT_REJECT_DIALOG_INBOX", "CONTRACT_REJECT_DIALOG_HEADER", "CONTRACT_APPROVAL_DIALOG_COMMENT", "CONTRACT_APPROVAL_DIALOG_INBOX", "CONTRACT_APPROVAL_DIALOG_HEADER", "CONTRACT_WITHDRAW_APPROVAL_DIALOG_COMMENT", "CONTRACT_WITHDRAW_APPROVAL_DIALOG_INBOX", "CONTRACT_WITHDRAW_APPROVAL_DIALOG_HEADER", "CONTRACT_CLOSE_DIALOG_COMMENT", "CONTRACT_CLOSE_DIALOG_INBOX", "CONTRACT_CLOSE_DIALOG_HEADER", "CONTRACT_REOPEN_DIALOG_COMMENT", "CONTRACT_REOPEN_DIALOG_INBOX", "CONTRACT_REOPEN_DIALOG_HEADER", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_REJECT", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "COMMITMENT_LINK", "COMMITMENT_SUBMIT_DIALOG_COMMENT", "COMMITMENT_SUBMIT_DIALOG_INBOX", "COMMITMENT_SUBMIT_DIALOG_HEADER", "COMMITMENT_REJECT_DIALOG_COMMENT", "COMMITMENT_REJECT_DIALOG_INBOX", "COMMITMENT_REJECT_DIALOG_HEADER", "COMMITMENT_APPROVAL_DIALOG_COMMENT", "COMMITMENT_APPROVAL_DIALOG_INBOX", "COMMITMENT_APPROVAL_DIALOG_HEADER", "COMMITMENT_WITHDRAW_APPROVAL_DIALOG_COMMENT", "COMMITMENT_WITHDRAW_APPROVAL_DIALOG_INBOX", "COMMITMENT_WITHDRAW_APPROVAL_DIALOG_HEADER", "COMMITMENT_CLOSE_DIALOG_COMMENT", "COMMITMENT_CLOSE_DIALOG_INBOX", "COMMITMENT_CLOSE_DIALOG_HEADER", "COMMITMENT_REOPEN_DIALOG_COMMENT", "COMMITMENT_REOPEN_DIALOG_INBOX", "COMMITMENT_REOPEN_DIALOG_HEADER", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_REJECT", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "CHANGE_ORDER_LINK", "CHANGE_ORDER_SUBMIT_DIALOG_COMMENT", "CHANGE_ORDER_SUBMIT_DIALOG_INBOX", "CHANGE_ORDER_SUBMIT_DIALOG_HEADER", "CHANGE_ORDER_REJECT_DIALOG_COMMENT", "CHANGE_ORDER_REJECT_DIALOG_INBOX", "CHANGE_ORDER_REJECT_DIALOG_HEADER", "CHANGE_ORDER_APPROVAL_DIALOG_COMMENT", "CHANGE_ORDER_APPROVAL_DIALOG_INBOX", "CHANGE_ORDER_APPROVAL_DIALOG_HEADER", "CHANGE_ORDER_WITHDRAW_APPROVAL_DIALOG_COMMENT", "CHANGE_ORDER_WITHDRAW_APPROVAL_DIALOG_INBOX", "CHANGE_ORDER_WITHDRAW_APPROVAL_DIALOG_HEADER", "CHANGE_ORDER_CLOSE_COMMENT", "CHANGE_ORDER_REOPEN_COMMENT", "CHANGE_ORDER_REJECT_COMMENT", "CHANGE_ORDER_APPROVE_COMMENT", "CHANGE_ORDER_SUBMIT_COMMENT", "CHANGE_ORDER_WITHDRAW_COMMENT", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_REJECT", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_VOID", "POTENTIAL_CHANGE_ORDER_LINK", "POTENTIAL_CHANGE_ORDER_SUBMIT_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_SUBMIT_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_SUBMIT_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_REOPEN_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_REOPEN_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_REOPEN_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_CLOSE_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_CLOSE_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_CLOSE_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_WITHDRAW_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_WITHDRAW_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_WITHDRAW_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "POTENTIAL_CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "POTENTIAL_CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "POTENTIAL_CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "MANUAL_POTENTIAL_CHANGE_ORDER_DEFAULT_SUBMIT_COMMENT", "MANUAL_POTENTIAL_CHANGE_ORDER_DEFAULT_REOPEN_COMMENT", "MANUAL_POTENTIAL_CHANGE_ORDER_DEFAULT_CLOSE_COMMENT", "MANUAL_POTENTIAL_CHANGE_ORDER_DEFAULT_WITHDRAW_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_LINK", "POTENTIAL_CHANGE_ORDER_PROPOSAL_SUBMIT_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_SUBMIT_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_PROPOSAL_SUBMIT_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_PROPOSAL_REJECT_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_REJECT_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_PROPOSAL_REJECT_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_PROPOSAL_APPROVAL_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_APPROVAL_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_PROPOSAL_APPROVAL_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_PROPOSAL_WITHDRAW_APPROVAL_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_WITHDRAW_APPROVAL_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_PROPOSAL_WITHDRAW_APPROVAL_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_PROPOSAL_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_STATUS_CHANGE_EMAIL_TITLE_REJECT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "POTENTIAL_CHANGE_ORDER_PROPOSAL_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_LINK", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_SUBMIT_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_SUBMIT_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_SUBMIT_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_ANSWER_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_ANSWER_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_ANSWER_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_REOPEN_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_REOPEN_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_REOPEN_DIALOG_HEADER", "PAYMENT_APPLICATION_LINK", "PAYMENT_APPLICATION_SUBMIT_DIALOG_COMMENT", "PAYMENT_APPLICATION_SUBMIT_DIALOG_INBOX", "PAYMENT_APPLICATION_SUBMIT_DIALOG_HEADER", "PAYMENT_APPLICATION_REJECT_DIALOG_COMMENT", "PAYMENT_APPLICATION_REJECT_DIALOG_INBOX", "PAYMENT_APPLICATION_REJECT_DIALOG_HEADER", "PAYMENT_APPLICATION_APPROVAL_DIALOG_COMMENT", "PAYMENT_APPLICATION_APPROVAL_DIALOG_INBOX", "PAYMENT_APPLICATION_APPROVAL_DIALOG_HEADER", "PAYMENT_APPLICATION_WITHDRAW_APPROVAL_DIALOG_COMMENT", "PAYMENT_APPLICATION_WITHDRAW_APPROVAL_DIALOG_INBOX", "PAYMENT_APPLICATION_WITHDRAW_APPROVAL_DIALOG_HEADER", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_REJECT", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_VOID", "CHANGE_EVENTS_SUBMIT_DIALOG_COMMENT", "CHANGE_EVENTS_SUBMIT_DIALOG_INBOX", "CHANGE_EVENTS_SUBMIT_DIALOG_HEADER", "CHANGE_EVENTS_VOID_DIALOG_COMMENT", "CHANGE_EVENTS_VOID_DIALOG_INBOX", "CHANGE_EVENTS_VOID_DIALOG_HEADER", "CHANGE_EVENTS_CLOSED_DIALOG_COMMENT", "CHANGE_EVENTS_CLOSED_DIALOG_INBOX", "CHANGE_EVENTS_CLOSED_DIALOG_HEADER", "CHANGE_EVENTS_REOPEN_DIALOG_COMMENT", "CHANGE_EVENTS_REOPEN_DIALOG_INBOX", "CHANGE_EVENTS_REOPEN_DIALOG_HEADER", "CHANGE_EVENTS_LINK", "MANUAL_CHANGE_EVENTS_DEFAULT_SUBMIT_COMMENT", "MANUAL_CHANGE_EVENTS_DEFAULT_VOID_COMMENT", "MANUAL_CHANGE_EVENTS_DEFAULT_CLOSED_COMMENT", "MANUAL_CHANGE_EVENTS_DEFAULT_REOPEN_COMMENT", "CHANGE_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "CHANGE_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "CHANGE_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "CHANGE_STATUS_CHANGE_EMAIL_TITLE_VOID", "WORKSPACE_FUND_ALLOCATION_DISTRIBUTE_EVENLY_WARNING", "WORKSPACE_FUND_ALLOCATION_RESET_WARNING", "FUND_HAS_MANUALLY_APPROPRIATED_VALUES", "FUNDS_REFRESH_LINK", "FUND_TIMEPHASE_VALIDATE_DISTRIBUTED_TOTALS", "FUNDS_TIMEPHASE_CONFIRM_START_DATE", "FUNDS_TIMEPHASE_CONFIRM_END_DATE", "FUND_TIMEPHASE_EDIT_START_DATE", "FUND_CHECK_VALIDITY_WITH_ISSUES", "FUND_TIMEPHASE_EDIT_END_DATE", "BP_FUNDS_REMOVE_FUNDS", "BP_FUNDS_REMOVE_FUNDS_WITH_ALLOCATION", "BP_FUNDS_ERROR_REMOVE_FUNDS", "IMPORT_P6_SUCCES", "IMPORT_P6_SUCCESS_DESCRIPTION", "IMPORT_P6_FAIL", "IMPORT_P6_FAIL_DESCRIPTION_SINGLE_PROJECT", "IMPORT_P6_FAIL_DESCRIPTION_MULTIPLE_PROJECT", "IMPORT_LOG_CURVE_ENTITY", "IMPORT_LOG_CURVE", "CURVE_COUNT_CREATE", "CURVE_COUNT_UPDATE", "CURVE_COUNT_NOTIMPORT", "CURVE_IMPORT_FAIL", "IMPORT_LOG_CALENDAR_ENTITY", "IMPORT_LOG_CALENDAR", "CALENDAR_COUNT_CREATE", "CALENDAR_COUNT_UPDATE", "CALENDAR_COUNT_NOTIMPORT", "CALENDAR_IMPORT_FAIL", "CALENDAR_EXCEPTION_NOT_FOUND_TO_DELETE", "IMPORT_LOG_PROJECT_CALENDAR", "PROJECT_CALENDAR_COUNT_CREATE", "PROJECT_CALENDAR_COUNT_UPDATE", "PROJECT_CALENDAR_COUNT_NOTIMPORT", "IMPORT_LOG_CODE_ENTITY", "IMPORT_LOG_CODES", "IMPORT_LOG_PROJECT_CODE", "CODE_COUNT_CREATE", "PROJECT_CODE_COUNT_CREATE", "CODE_COUNT_UPDATE", "PROJECT_CODE_COUNT_UPDATE", "IMPORT_LOG_PROJECT_CODE_COUNT_FAILED", "CODE_COUNT_NOTIMPORT", "PROJECT_CODE_COUNT_NOTIMPORT", "CODE_IMPORT_FAIL", "CODE_VALUE_ASSIGNMENT_NOT_FOUND_TO_DELETE", "CUSTOM_LOG_OBJECT_CODE_VALUE_ASSIGNMENT_NOT_FOUND_TO_DELETE", "DOCUMENT_CODE_VALUE_ASSIGNMENT_NOT_FOUND_TO_DELETE", "IMPORT_LOG_CODE_VALUE_ENTITY", "IMPORT_LOG_CODE_VALUES", "IMPORT_LOG_PROJECT_CODE_VALUES", "CODE_VALUE_COUNT_CREATE", "PROJECT_CODE_VALUE_COUNT_CREATE", "CODE_VALUE_COUNT_UPDATE", "PROJECT_CODE_VALUE_COUNT_UPDATE", "CODE_VALUE_COUNT_NOTIMPORT", "PROJECT_CODE_VALUE_COUNT_NOTIMPORT", "CODE_VALUE_IMPORT_FAIL", "IMPORT_LOG_RESOURCE_ENTITY", "IMPORT_LOG_RESOURCES", "RESOURCE_COUNT_CREATE", "RESOURCE_COUNT_UPDATE", "RESOURCE_COUNT_NOTIMPORT", "RESOURCE_IMPORT_FAIL", "IMPORT_LOG_RESOURCERATE_ENTITY", "IMPORT_LOG_RESOURCERATES", "RESOURCERATE_COUNT_CREATE", "RESOURCERATE_COUNT_UPDATE", "RESOURCERATE_COUNT_NOTIMPORT", "RESOURCERATE_IMPORT_FAIL", "IMPORT_LOG_ROLE_ENTITY", "IMPORT_LOG_ROLES", "ROLE_COUNT_CREATE", "ROLE_COUNT_UPDATE", "ROLE_COUNT_NOTIMPORT", "ROLE_IMPORT_FAIL", "IMPORT_LOG_ROLELIMIT_ENTITY", "IMPORT_LOG_ROLELIMITS", "ROLELIMIT_COUNT_CREATE", "ROLELIMIT_COUNT_UPDATE", "ROLELIMIT_COUNT_NOTIMPORT", "ROLELIMIT_IMPORT_FAIL", "IMPORT_LOG_PROJECT_ENTITY", "IMPORT_LOG_PROJECTS", "PROJECT_COUNT_CREATE", "PROJECT_COUNT_UPDATE", "PROJECT_COUNT_NOTIMPORT", "PROJECT_IMPORT_FAIL", "IMPORT_LOG_BASELINE_PROJECT_ENTITY", "IMPORT_LOG_BASELINE_PROJECTS", "BASELINE_PROJECT_COUNT_CREATE", "BASELINE_PROJECT_COUNT_UPDATE", "BASELINE_PROJECT_COUNT_NOTIMPORT", "BASELINE_PROJECT_COUNT_FAILED", "IMPORT_LOG_SCENARIO_PROJECT_ENTITY", "IMPORT_LOG_SCENARIO_PROJECTS", "SCENARIO_PROJECT_COUNT_CREATE", "SCENARIO_PROJECT_COUNT_UPDATE", "SCENARIO_PROJECT_COUNT_NOTIMPORT", "SCENARIO_PROJECT_COUNT_FAILED", "IMPORT_LOG_IMPORT_ACTION_DETAILS", "IMPORT_LOG_CURRENT_SCHEDULE", "IMPORT_LOG_DETAIL_IMPORT_ACTION_CREATE_NEW_PROJECT", "IMPORT_LOG_DETAIL_IMPORT_ACTION_UPDATE_EXISTING_PROJECT", "IMPORT_LOG_DETAIL_IMPORT_ACTION_CREATE_NEW_BASELINE", "IMPORT_LOG_DETAIL_IMPORT_ACTION_UPDATE_EXISTING_BASELINE", "IMPORT_LOG_DETAIL_IMPORT_ACTION_CREATE_NEW_SCENARIO", "IMPORT_LOG_DETAIL_IMPORT_ACTION_UPDATE_EXISTING_SCENARIO", "IMPORT_LOG_DETAIL_MESSAGE_BASELINE_CREATED_NEW", "IMPORT_LOG_DETAIL_MESSAGE_SCENARIO_CREATED_NEW", "IMPORT_LOG_DETAIL_MESSAGE_ORIGINAL_BASELINE_CREATED_NEW", "IMPORT_LOG_DETAIL_MESSAGE_BASELINE_UPDATED_EXISTING", "IMPORT_LOG_DETAIL_MESSAGE_SCENARIO_UPDATED_EXISTING", "IMPORT_LOG_DETAIL_MESSAGE_PROJECT_UPDATED_EXISTING", "IMPORT_LOG_DETAIL_MESSAGE_NOT_IMPORTED", "SUMMARY_TOTAL_COUNT_CREATE", "SUMMARY_TOTAL_COUNT_UPDATE", "SUMMARY_TOTAL_COUNT_NOTIMPORT", "SUMMARY_TOTAL_COUNT_FAIL", "IMPORT_LOG_BASELINE_RELATIONSHIPS", "BASELINE_RELATIONSHIP_COUNT_CREATE", "BASELINE_RELATIONSHIP_COUNT_UPDATE", "BASELINE_RELATIONSHIP_COUNT_NOTIMPORT", "BASELINE_RELATIONSHIP_COUNT_DELETE", "BASELINE_RELATIONSHIP_COUNT_FAILED", "PROJECT_EXTERNAL_COUNT_CREATE", "PROJECT_EXTERNAL_IMPORT_FAIL", "IMPORT_LOG_NOTEBOOKTOPIC_ENTITY", "IMPORT_LOG_NOTEBOOKTOPIC", "IMPORT_LOG_ACTIVITY_NOTES", "NOTEBOOKTOPIC_COUNT_CREATE", "NOTEBOOKTOPIC_COUNT_UPDATE", "NOTEBOOKTOPIC_COUNT_NOTIMPORT", "NOTEBOOKTOPIC_COUNT_FAILED", "IMPORT_LOG_UNITSOFMEASURE_ENTITY", "IMPORT_LOG_UNITSOFMEASURE", "UNITSOFMEASURE_COUNT_CREATE", "UNITSOFMEASURE_COUNT_UPDATE", "UNITSOFMEASURE_COUNT_NOTIMPORT", "UNITSOFMEASURE_IMPORT_FAIL", "UNITSOFMEASURE_DISPLAY_NAME", "IMPORT_LOG_ACTIVITY_ENTITY", "IMPORT_LOG_ACTIVITIES", "ACTIVITY_COUNT_CREATE", "ACTIVITY_COUNT_UPDATE", "ACTIVITY_COUNT_DELETE", "ACTIVITY_COUNT_NOTIMPORT", "ACTIVITY_IMPORT_FAIL", "IMPORT_LOG_BASELINE_ACTIVITY_ENTITY", "IMPORT_LOG_BASELINE_ACTIVITIES", "BASELINE_ACTIVITY_COUNT_CREATE", "BASELINE_ACTIVITY_COUNT_UPDATE", "BASELINE_ACTIVITY_COUNT_DELETE", "BASELINE_ACTIVITY_COUNT_NOTIMPORT", "BASELINE_ACTIVITY_IMPORT_FAIL", "IMPORT_LOG_SCENARIO_ACTIVITIES", "SCENARIO_ACTIVITY_COUNT_CREATE", "SCENARIO_ACTIVITY_COUNT_UPDATE", "SCENARIO_ACTIVITY_COUNT_DELETE", "SCENARIO_ACTIVITY_COUNT_NOTIMPORT", "SCENARIO_ACTIVITY_IMPORT_FAIL", "IMPORT_LOG_ASSIGNMENT_ENTITY", "IMPORT_LOG_ASSIGNMENTS", "ASSIGNMENT_COUNT_CREATE", "ASSIGNMENT_COUNT_UPDATE", "ASSIGNMENT_COUNT_NOTIMPORT", "ASSIGNMENT_COUNT_DELETE", "ASSIGNMENT_IMPORT_FAIL", "IMPORT_LOG_BASELINE_ASSIGNMENT_ENTITY", "IMPORT_LOG_BASELINE_ASSIGNMENTS", "BASELINE_ASSIGNMENT_COUNT_CREATE", "BASELINE_ASSIGNMENT_COUNT_UPDATE", "BASELINE_ASSIGNMENT_COUNT_NOTIMPORT", "BASELINE_ASSIGNMENT_COUNT_DELETE", "BASELINE_ASSIGNMENT_IMPORT_FAIL", "IMPORT_LOG_SCENARIO_ASSIGNMENT_ENTITY", "IMPORT_LOG_SCENARIO_ASSIGNMENTS", "SCENARIO_ASSIGNMENT_COUNT_CREATE", "SCENARIO_ASSIGNMENT_COUNT_UPDATE", "SCENARIO_ASSIGNMENT_COUNT_NOTIMPORT", "SCENARIO_ASSIGNMENT_COUNT_DELETE", "SCENARIO_ASSIGNMENT_IMPORT_FAIL", "IMPORT_LOG_RELATIONSHIP_ENTITY", "IMPORT_LOG_RELATIONSHIPS", "RELATIONSHIP_COUNT_CREATE", "RELATIONSHIP_COUNT_UPDATE", "RELATIONSHIP_COUNT_NOTIMPORT", "RELATIONSHIP_COUNT_DELETE", "RELATIONSHIP_IMPORT_FAIL", "IMPORT_LOG_SCENARIO_RELATIONSHIPS", "SCENARIO_RELATIONSHIP_COUNT_CREATE", "SCENARIO_RELATIONSHIP_COUNT_UPDATE", "SCENARIO_RELATIONSHIP_COUNT_NOTIMPORT", "SCENARIO_RELATIONSHIP_COUNT_DELETE", "SCENARIO_RELATIONSHIP_COUNT_FAILED", "IMPORT_LOG_WBS", "WBS_COUNT_CREATE", "WBS_COUNT_UPDATE", "WBS_COUNT_NOTIMPORT", "WBS_IMPORT_FAIL", "WBS_DELETE_SUCCESS", "WBS_DELETE_FAIL", "IMPORT_LOG_BASELINE_WBS", "IMPORT_LOG_BASELINE_WBS_ENTITY", "BASELINE_WBS_COUNT_CREATE", "BASELINE_WBS_COUNT_UPDATE", "BASELINE_WBS_COUNT_NOTIMPORT", "BASELINE_WBS_COUNT_FAILED", "BASELINE_WBS_IMPORT_FAIL", "BASELINE_WBS_COUNT_DELETE", "IMPORT_LOG_SCENARIO_WBS", "SCENARIO_WBS_COUNT_CREATE", "SCENARIO_WBS_COUNT_UPDATE", "SCENARIO_WBS_COUNT_DELETE", "SCENARIO_WBS_COUNT_NOTIMPORT", "SCENARIO_WBS_COUNT_FAILED", "SCENARIO_WBS_IMPORT_FAIL", "IMPORT_LOG_ASSIGNMENTUDFS", "ASSIGNMENTUDF_COUNT_TOTAL", "ASSIGNMENTUDF_COUNT_CREATE", "ASSIGNMENTUDF_COUNT_UPDATE", "ASSIGNMENTUDF_COUNT_NOTIMPORT", "ASSIGNMENTUDF_COUNT_FAILED", "ASSIGNMENTUDF_IMPORT_FAIL", "IMPORT_LOG_ACTIVITYUDFS", "ACTIVITYUDF_COUNT_TOTAL", "ACTIVITYUDF_COUNT_CREATE", "ACTIVITYUDF_COUNT_UPDATE", "ACTIVITYUDF_COUNT_NOTIMPORT", "ACTIVITYUDF_COUNT_FAILED", "ACTIVITYUDF_IMPORT_FAIL", "IMPORT_LOG_WBSUDFS", "WBSUDF_COUNT_TOTAL", "WBSUDF_COUNT_CREATE", "WBSUDF_COUNT_UPDATE", "WBSUDF_COUNT_NOTIMPORT", "WBSUDF_COUNT_FAILED", "WBSUDF_IMPORT_FAIL", "IMPORT_LOG_PROJECTUDFS", "PROJECTUDF_COUNT_TOTAL", "PROJECTUDF_COUNT_CREATE", "PROJECTUDF_COUNT_UPDATE", "PROJECTUDF_COUNT_NOTIMPORT", "PROJECTUDF_COUNT_FAILED", "PROJECTUDF_IMPORT_FAIL", "IMPORT_LOG_RISKUDFS", "RISKUDF_COUNT_TOTAL", "RISKUDF_COUNT_CREATE", "RISKUDF_COUNT_UPDATE", "RISKUDF_COUNT_NOTIMPORT", "RISKUDF_COUNT_FAILED", "RISKUDF_IMPORT_FAIL", "IMPORT_LOG_RISKSCORETYPE_ENTITY", "IMPORT_LOG_RISKSCORETYPE", "RISKSCORETYPE_COUNT_CREATE", "RISKSCORETYPE_COUNT_UPDATE", "RISKSCORETYPE_COUNT_NOTIMPORT", "RISKSCORETYPE_IMPORT_FAIL", "IMPORT_LOG_RISKMATRIX_ENTITY", "IMPORT_LOG_RISKMATRIX", "RISKMATRIX_COUNT_CREATE", "RISKMATRIX_COUNT_UPDATE", "RISKMATRIX_COUNT_NOTIMPORT", "RISKMATRIX_IMPORT_FAIL", "IMPORT_LOG_PROJECTRISK_ENTITY", "IMPORT_LOG_PROJECTRISKS", "PROJECTRISKS_COUNT_CREATE", "PROJECTRISKS_COUNT_UPDATE", "PROJECTRISKS_COUNT_DELETE", "PROJECTRISKS_COUNT_NOTIMPORT", "PROJECTRISKS_IMPORT_FAIL", "IMPORT_LOG_ACTIVITYRISK_ENTITY", "IMPORT_LOG_ACTIVITYRISKS", "ACTIVITYRISKS_COUNT_TOTAL", "ACTIVITYRISKS_COUNT_CREATE", "ACTIVITYRISKS_COUNT_UPDATE", "ACTIVITYRISKS_COUNT_NOTIMPORT", "ACTIVITYRISKS_COUNT_DELETE", "ACTIVITYRISKS_IMPORT_FAIL", "IMPORT_LOG_RISKMITIGATION_ENTITY", "IMPORT_LOG_RISKMITIGATION", "RISKMITIGATION_COUNT_TOTAL", "RISKMITIGATION_COUNT_CREATE", "RISKMITIGATION_COUNT_UPDATE", "RISKMITIGATION_COUNT_NOTIMPORT", "RISKMITIGATION_COUNT_DELETE", "RISKMITIGATION_IMPORT_FAIL", "IMPORT_LOG_RESOURCEROLEASSIGNMENT_ENTITY", "IMPORT_LOG_RESOURCEROLEASSIGNMENTS", "RESOURCEROLEASSIGNMENT_COUNT_CREATE", "RESOURCEROLEASSIGNMENT_COUNT_UPDATE", "RESOURCEROLEASSIGNMENT_COUNT_NOTIMPORT", "RESOURCEROLEASSIGNMENT_COUNT_DELETE", "PROJECT_COUNT_FAILED", "RESOURCE_COUNT_FAILED", "CALENDAR_COUNT_FAILED", "PROJECT_CALENDAR_COUNT_FAILED", "CODE_COUNT_FAILED", "CODE_VALUE_COUNT_FAILED", "CURVE_COUNT_FAILED", "RESOURCERATE_COUNT_FAILED", "ROLE_COUNT_FAILED", "ROLELIMIT_COUNT_FAILED", "ACTIVITY_COUNT_FAILED", "ASSIGNMENT_COUNT_FAILED", "RELATIONSHIP_COUNT_FAILED", "WBS_COUNT_FAILED", "RISKMATRIX_COUNT_FAILED", "RISKSCORETYPE_COUNT_FAILED", "PROJECTRISKS_COUNT_FAILED", "ACTIVITYRISKS_COUNT_FAILED", "RISKMITIGATION_COUNT_FAILED", "RESOURCEROLEASSIGNMENT_COUNT_FAILED", "UNITSOFMEASURE_COUNT_FAILED", "FORM_TASK_DRAFT_NOTIFICATION", "SHARED_DATA_CONFIRM_REMOVE", "IMPORT_LOG_BASELINE_CATEGORY_ENTITY", "IMPORT_LOG_BASELINE_CATEGORY", "BASELINE_CATEGORY_COUNT_CREATE", "BASELINE_CATEGORY_COUNT_UPDATE", "BASELINE_CATEGORY_COUNT_NOTIMPORT", "BASELINE_CATEGORY_COUNT_IMPORT_FAILED", "IMPORT_LOG_BASELINE_CATEGORY_MULTIPLE_ENTITY_FOUND_NEW_ENTITY_CREATED", "PORTFOLIO_MEASURE_RECALCULATE_MEASURE_SUCCESFUL", "PORTFOLIO_MEASURE_RECALCULATE_MEASURE_FOR_PORTFOLIOS_SUCCESFUL", "PORTFOLIO_MEASURE_RECALCULATE_MEASURE_FOR_PORTFOLIOS_FAILED", "MEASURES_ACTUAL_EXPRESSION_REQUIRED", "MEASURE_VALIDATION_SUCCESSFUL_DETAIL", "WORKSPACE_MEASURE_RECALCULATE_SUCCESSFUL", "WORKSPACE_MEASURE_RECALCULATE_FAILED", "PROJECT_MEASURE_BY_PORTFOLIO_RECALCULATE_SUCCESSFUL", "PROJECT_MEASURE_BY_PORTFOLIO_RECALCULATE_FAILED", "WORKSPACE_MEASURE_PROGRAMS_RECALCULATE_SUCCESSFUL", "WORKSPACE_MEASURE_PROGRAMS_RECALCULATE_FAILED", "PROGRAM_MEASURES_BY_PORTFOLIO_RECALCULATE_SUCCESSFUL", "PROGRAM_MEASURES_BY_PORTFOLIO_RECALCULATE_FAILED", "WORKSPACE_MOVE_FAILED", "WORKSPACE_MOVE_FAILURE_REASON", "WORKSPACE_MOVE_COMPLETED", "WORKSPACE_MOVE_RECORD_NOT_SAVED", "WORKSPACE_MOVE_RECORD_SAVED", "WORKSPACE_MOVE_RENAMED", "MOVE_LOG_LOCATION_ENTITY", "WORKSPACE_MOVE_EVAL_REASON", "WORKSPACE_MOVE_EVAL_RECOMMENDATION", "WORKSPACE_MOVE_RECOMMENDATION", "WORKSPACE_MOVE_CBS_REASON", "WORKSPACE_MOVE_CBS_RECOMMENDATION", "WORKSPACE_MOVE_WORKFLOW_CONFIGURATION_REASON", "WORKSPACE_MOVE_WORKFLOW_CONFIGURATION_RECOMMENDATION", "WORKSPACE_MOVE_SECURITY_PROFILE_COUNT_MOVED", "WORKSPACE_MOVE_FORM_COUNT_MOVED", "WORKSPACE_MOVE_WORKFLOW_CONFIG_COUNT_MOVED", "WORKSPACE_MOVE_WORKFLOW_DESIGN_COUNT_MOVED", "MOVE_LOG_WORKFLOW_CONFIGURATION_ENTITY", "MOVE_LOG_WORKFLOW_DESIGN_ENTITY", "WORKSPACE_MOVE_USERS_ACCESS_COUNT_MOVED", "WORKSPACE_MOVE_USER_GROUP_COUNT_MOVED", "WORKSPACE_MOVE_NOTEBOOKTOPIC_COUNT_MOVED", "WORKSPACE_MOVE_NOTEBOOKTOPIC_COUNT_RENAMED", "WORKSPACE_MOVE_NOTEBOOKTOPIC_COUNT_REMOVED", "MOVE_LOG_NOTEBOOKTOPIC_ENTITY", "WORKSPACE_MOVE_COLUMN_DEFINITION_RELATIONSHIP_LIST_REASON", "WORKSPACE_DELETE_ERRORS", "WORKSPACE_TOTAL_COUNT_ERRORS", "WORKSPACE_DELETE_FAILED", "WORKSPACE_DELETE_COMPLETED", "WORKSPACE_DELETE_RECORD_NOT_SAVED", "WORKSPACE_DELETE_RECORD_SAVED", "WORKSPACE_DELETE_RENAMED", "WORKSPACE_DELETE_ID_UPDATED", "WORKSPACE_DELETE_MOVED", "WORKSPACE_DELETE_USERGROUPS", "WORKSPACE_DELETE_CBS_REASON", "WORKSPACE_DELETE_CBS_RECOMMENDATION", "WORKSPACE_DELETE_FAILURE_REASON", "WORKSPACE_DELETE_FAILURE_RECOMMENDATION", "WORKSPACE_DELETE_EVAL_REASON", "WORKSPACE_DELETE_EVAL_RECOMMENDATION", "WORKSPACE_DELETE_FAILURE_RELATIONSHIP_REASON", "WORKSPACE_DELETE_FAILURE_RELATIONSHIP_RECOMMENDATION", "WORKSPACE_DELETE_ANALYSIS_VIEW_COUNT_MOVED", "WORKSPACE_DELETE_ANALYSIS_VIEW_COUNT_RENAMED", "WORKSPACE_DELETE_ANALYSIS_VIEW_COUNT_REMOVED", "WORKSPACE_DELETE_BASELINE_CATEGORY_COUNT_MOVED", "WORKSPACE_DELETE_BASELINE_CATEGORY_COUNT_RENAMED", "WORKSPACE_DELETE_BASELINE_CATEGORY_COUNT_REMOVED", "WORKSPACE_DELETE_CALENDAR_COUNT_MOVED", "WORKSPACE_DELETE_CALENDAR_COUNT_RENAMED", "WORKSPACE_DELETE_CALENDAR_COUNT_REMOVED", "WORKSPACE_DELETE_CODES_COUNT_MOVED", "WORKSPACE_DELETE_CODES_COUNT_RENAMED", "WORKSPACE_DELETE_CODES_COUNT_REMOVED", "WORKSPACE_DELETE_COST_CATEGORY_COUNT_MOVED", "WORKSPACE_DELETE_COST_CATEGORY_COUNT_RENAMED", "WORKSPACE_DELETE_COST_CATEGORY_COUNT_REMOVED", "WORKSPACE_DELETE_CURRENCY_COUNT_MOVED", "WORKSPACE_DELETE_CURRENCY_COUNT_RENAMED", "WORKSPACE_DELETE_CURRENCY_COUNT_REMOVED", "WORKSPACE_DELETE_CURVE_COUNT_MOVED", "WORKSPACE_DELETE_CURVE_COUNT_RENAMED", "WORKSPACE_DELETE_CURVE_COUNT_REMOVED", "WORKSPACE_DELETE_CUSTOM_LOG_COUNT_MOVED", "WORKSPACE_DELETE_CUSTOM_LOG_COUNT_RENAMED", "WORKSPACE_DELETE_CUSTOM_LOG_COUNT_REMOVED", "WORKSPACE_DELETE_CONFIGURED_FIELDS_COUNT_MOVED", "WORKSPACE_DELETE_CONFIGURED_FIELDS_COUNT_RENAMED", "WORKSPACE_DELETE_CONFIGURED_FIELDS_COUNT_REMOVED", "WORKSPACE_DELETE_DASHBOARD_COUNT_MOVED", "WORKSPACE_DELETE_DASHBOARD_COUNT_RENAMED", "WORKSPACE_DELETE_DASHBOARD_COUNT_REMOVED", "WORKSPACE_DELETE_DASHBOARD_IMAGE_COUNT_MOVED", "WORKSPACE_DELETE_DASHBOARD_IMAGE_COUNT_RENAMED", "WORKSPACE_DELETE_DASHBOARD_IMAGE_COUNT_REMOVED", "WORKSPACE_DELETE_DOCUMENTS_COUNT_MOVED", "WORKSPACE_DELETE_DOCUMENTS_COUNT_RENAMED", "WORKSPACE_DELETE_DOCUMENTS_COUNT_REMOVED", "WORKSPACE_DELETE_EVALUATION_SUB_CATEGORY_COUNT_MOVED", "WORKSPACE_DELETE_EVALUATION_SUB_CATEGORY_COUNT_RENAMED", "WORKSPACE_DELETE_EVALUATION_SUB_CATEGORY_COUNT_REMOVED", "WORKSPACE_DELETE_FMS_COUNT_MOVED", "WORKSPACE_DELETE_FMS_COUNT_RENAMED", "WORKSPACE_DELETE_FMS_COUNT_REMOVED", "WORKSPACE_DELETE_FILTER", "WORKSPACE_DELETE_FILTER_COUNT_MOVED", "WORKSPACE_DELETE_FILTER_COUNT_RENAMED", "WORKSPACE_DELETE_FILTER_COUNT_REMOVED", "WORKSPACE_DELETE_FORM_REASON", "WORKSPACE_DELETE_FORM_RECOMMENDATION", "WORKSPACE_DELETE_FORM_COUNT_MOVED", "WORKSPACE_DELETE_FORM_COUNT_RENAMED", "WORKSPACE_DELETE_FORM_COUNT_REMOVED", "WORKSPACE_DELETE_FUND_COUNT_MOVED", "WORKSPACE_DELETE_FUND_COUNT_RENAMED", "WORKSPACE_DELETE_FUND_COUNT_REMOVED", "WORKSPACE_DELETE_HOLIDAY_COUNT_MOVED", "WORKSPACE_DELETE_HOLIDAY_COUNT_RENAMED", "WORKSPACE_DELETE_HOLIDAY_COUNT_REMOVED", "WORKSPACE_DELETE_IDEA_COUNT_MOVED", "WORKSPACE_DELETE_IDEA_COUNT_RENAMED", "WORKSPACE_DELETE_IDEA_COUNT_REMOVED", "WORKSPACE_DELETE_INSIGHT_COUNT_MOVED", "WORKSPACE_DELETE_INSIGHT_COUNT_RENAMED", "WORKSPACE_DELETE_INSIGHT_COUNT_REMOVED", "WORKSPACE_DELETE_LOCATION_COUNT_MOVED", "WORKSPACE_DELETE_LOCATION_COUNT_RENAMED", "WORKSPACE_DELETE_LOCATION_COUNT_REMOVED", "LOCATION_COUNT_MOVED", "LOCATION_COUNT_RENAMED", "ROLES_RESOURCE_COUNT_MOVED", "FMS_COUNT_MOVED", "WORKSPACE_DELETE_MEASURE_COUNT_MOVED", "WORKSPACE_DELETE_MEASURE_COUNT_RENAMED", "WORKSPACE_DELETE_MEASURE_COUNT_REMOVED", "WORKSPACE_DELETE_PORTFOLIO_COUNT_MOVED", "WORKSPACE_DELETE_PORTFOLIO_COUNT_RENAMED", "WORKSPACE_DELETE_PORTFOLIO_COUNT_REMOVED", "WORKSPACE_DELETE_PROJECT_COUNT_MOVED", "WORKSPACE_DELETE_PROJECT_COUNT_RENAMED", "WORKSPACE_DELETE_PROJECT_COUNT_REMOVED", "WORKSPACE_DELETE_PROGRAM_COUNT_MOVED", "WORKSPACE_DELETE_PROGRAM_COUNT_RENAMED", "WORKSPACE_DELETE_PROGRAM_COUNT_REMOVED", "WORKSPACE_DELETE_RC_COUNT_MOVED", "WORKSPACE_DELETE_RC_COUNT_RENAMED", "WORKSPACE_DELETE_RC_COUNT_REMOVED", "WORKSPACE_DELETE_REASON_COUNT_MOVED", "WORKSPACE_DELETE_REASON_COUNT_RENAMED", "WORKSPACE_DELETE_REASON_COUNT_REMOVED", "WORKSPACE_DELETE_REPORT_COUNT_MOVED", "WORKSPACE_DELETE_REPORT_COUNT_RENAMED", "WORKSPACE_DELETE_REPORT_COUNT_REMOVED", "WORKSPACE_DELETE_ROLE_RESOURCE", "WORKSPACE_DELETE_RESOURCE_COUNT_MOVED", "WORKSPACE_DELETE_RESOURCE_COUNT_RENAMED", "WORKSPACE_DELETE_RESOURCE_COUNT_REMOVED", "WORKSPACE_DELETE_RISK_MATRIX_COUNT_MOVED", "WORKSPACE_DELETE_RISK_MATRIX_COUNT_RENAMED", "WORKSPACE_DELETE_RISK_MATRIX_COUNT_REMOVED", "WORKSPACE_DELETE_RISK_SCORE_TYPE_COUNT_MOVED", "WORKSPACE_DELETE_RISK_SCORE_TYPE_COUNT_RENAMED", "WORKSPACE_DELETE_RISK_SCORE_TYPE_COUNT_REMOVED", "WORKSPACE_DELETE_ROC_COUNT_MOVED", "WORKSPACE_DELETE_ROC_COUNT_RENAMED", "WORKSPACE_DELETE_ROC_COUNT_REMOVED", "WORKSPACE_DELETE_STRATEGY_COUNT_MOVED", "WORKSPACE_DELETE_STRATEGY_COUNT_RENAMED", "WORKSPACE_DELETE_STRATEGY_COUNT_REMOVED", "WORKSPACE_DELETE_STRATEGY_TYPE_COUNT_MOVED", "WORKSPACE_DELETE_STRATEGY_TYPE_COUNT_RENAMED", "WORKSPACE_DELETE_STRATEGY_TYPE_COUNT_REMOVED", "WORKSPACE_DELETE_SECURITY_PROFILE_COUNT_MOVED", "WORKSPACE_DELETE_SECURITY_PROFILE_COUNT_RENAMED", "WORKSPACE_DELETE_SECURITY_PROFILE_COUNT_REMOVED", "WORKSPACE_DELETE_UOM_COUNT_MOVED", "WORKSPACE_DELETE_UOM_COUNT_RENAMED", "WORKSPACE_DELETE_UOM_COUNT_REMOVED", "WORKSPACE_DELETE_USERS_COUNT_MOVED", "WORKSPACE_DELETE_USERS_COUNT_RENAMED", "WORKSPACE_DELETE_USERS_COUNT_REMOVED", "WORKSPACE_DELETE_USER_GROUP_COUNT_MOVED", "WORKSPACE_DELETE_USER_GROUP_COUNT_RENAMED", "WORKSPACE_DELETE_USER_GROUP_COUNT_REMOVED", "WORKSPACE_DELETE_VIEW_COUNT_MOVED", "WORKSPACE_DELETE_VIEW_COUNT_RENAMED", "WORKSPACE_DELETE_VIEW_COUNT_REMOVED", "WORKSPACE_DELETE_WORKFLOW_CONFIG_COUNT_MOVED", "WORKSPACE_DELETE_WORKFLOW_CONFIG_COUNT_RENAMED", "WORKSPACE_DELETE_WORKFLOW_CONFIG_COUNT_REMOVED", "WORKSPACE_DELETE_WORKFLOW_DESIGN_COUNT_MOVED", "WORKSPACE_DELETE_WORKFLOW_DESIGN_COUNT_RENAMED", "WORKSPACE_DELETE_WORKFLOW_DESIGN_COUNT_REMOVED", "WORKSPACE_DELETE_WORKFLOW_INSTANCE_COUNT_MOVED", "WORKSPACE_DELETE_WORKFLOW_INSTANCE_COUNT_RENAMED", "WORKSPACE_DELETE_WORKFLOW_INSTANCE_COUNT_REMOVED", "WORKSPACE_DELETE_WORKSPACE_COUNT_MOVED", "WORKSPACE_DELETE_WORKSPACE_COUNT_RENAMED", "WORKSPACE_DELETE_WORKSPACE_COUNT_REMOVED", "WORKSPACE_HARD_DELETE_NOTIFY_INITIATE", "WORKSPACE_HARD_DELETE_NOTIFY_INITIATE_DESCRIPTION", "WORKSPACE_HARD_DELETE_NOTIFY_SUCCESSFUL", "WORKSPACE_HARD_DELETE_NOTIFY_SUCCESSFUL_DESCRIPTION", "WORKSPACE_HARD_DELETE_NOTIFY_INCOMPLETE", "WORKSPACE_HARD_DELETE_NOTIFY_INCOMPLETE_DESCRIPTION", "WORKSPACE_HARD_DELETE_NOTIFY_FAILED", "WORKSPACE_HARD_DELETE_NOTIFY_FAILED_DESCRIPTION", "WORKSPACE_HARD_DELETE_VIEW_LOG_FAILED", "VALIDATION_UNIQUENESS_INFO", "VALIDATION_UNIQUENESS_CONFLICT_CONFIRM", "VALIDATION_UNIQUENESS_CONFLICT_SUBHEAD", "CLOSEOUT_PERIOD_COMPLETED_NAME", "CLOSEOUT_PERIOD_COMPLETED_DESCRIPTION", "PROXYUSER_ASSIGNED_NOTIFICATION", "PROXYUSER_PERIOD_START_NOTIFICATION", "PROXYUSER_PERIOD_END_NOTIFICATION", "PROXYUSER_ACCEPT_CONSENT_NOTICE", "GET_PRIME_EMAIL_SUBJECT", "GET_PRIME_EMAIL_TITLE", "GET_PRIME_EMAIL_BUTTON", "GET_PRIME_EMAIL_APP_STORE_LINK", "GET_PRIME_EMAIL_DESCRIPTION", "GET_PRIME_EMAIL_INSTRUCTIONS", "PORTFOLIO_AUTO_REFRESH_SUCCESS_HEADER", "PORTFOLIO_AUTO_REFRESH_SUCCESS_DETAIL", "PORTFOLIO_AUTO_REFRESH_FAILURE_HEADER", "PORTFOLIO_AUTO_REFRESH_FAILURE_DETAIL", "TASK_DUE_DATE_ON_NON_WORK_DAY", "TASK_COMPLETED_DATE_IN_FUTURE", "TASK_COMPLETED_DATE_AFTER_LATEST_COMMITMENT", "TASK_OUTSIDE_PLANNING_PERIOD", "TASKS_PLANNING_PERIOD_EARLY_BOUND_MAX", "TASKS_PLANNING_PERIOD_LATE_BOUND_MAX", "TASKS_CONFIRM_DELETE_COMMITMENT", "TASKS_CONFIRM_DELETE_LAST_COMMITMENT", "TASKS_CONFIRM_ADD_COMMITMENT_SAME_DATE", "WORK_MANAGEMENT_TASKS_REFRESH_LINK", "WORK_MANAGEMENT_FILTER_ALL_WEEKS_HINT", "TASK_COMPLETED_DATE_ON_NON_WORK_DAY", "TASK_MANAGEMENT_TASK_ACCEPT_PROPOSED_DUE_DATE_CONFIRMATION", "TASKS_COPY_PASTE_SUCCESS", "TASKS_COPY_PASTE_FAIL", "CAP_PLAN_ALLOCATION_APPROVED_BY", "CAP_PLAN_REVIEWED_AND_COMMITTED", "CAP_PLAN_VIEW_RESOURCE_DEMANDS", "DOCEXCHANGE_EMPTY_STATE_MESSAGE", "DOCEXCHANGE_REVISION_NEEDED", "DOCEXCHANGE_SET_AS_DRAFT", "DOCEXCHANGE_CANCEL", "DOCEXCHANGE_CHANGE_COMPANY", "RP_NON_TIME_PHASE_GRID_MODIFIES_SPREAD_DATA", "RP_SCENARIO_UNDER_REVIEW_NOTIFICATION_HEADER", "RP_SCENARIO_UNDER_REVIEW_NOTIFICATION_DESCRIPTION", "RP_SCENARIO_UNDER_APPROVAL_NOTIFICATION_HEADER", "RP_SCENARIO_UNDER_APPROVAL_NOTIFICATION_DESCRIPTION", "RP_SCENARIO_UNDER_DELETION_NOTIFICATION", "RM_RECALCULATE_RESOURCE_ASSIGNMENT", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_PROJECT_OWNER_SUCCESS_HEADER", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_PROJECT_OWNER_SUCCESS_DESC", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_PROJECT_OWNER_SUCCESS_HEADER", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_PROJECT_OWNER_SUCCESS_DESC", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "RM_RESOURCEPLANNING_SWITCH_SCENARIO_CONFIRMATION", "RM_RESOURCE_SCENARIO_PROJECT_COST_REFRESH_SUCCESS_HEADER", "RM_RESOURCE_SCENARIO_PROJECT_COST_REFRESH_SUCCESS_DESC", "RM_RESOURCE_SCENARIO_PROJECT_COST_REFRESH_FAILURE_HEADER", "RM_RESOURCE_SCENARIO_PROJECT_COST_REFRESH_FAILURE_DESC", "RM_RESOURCE_SCENARIO_ALLOCATION_COST_REFRESH_SUCCESS_HEADER", "RM_RESOURCE_SCENARIO_ALLOCATION_COST_REFRESH_SUCCESS_DESC", "RM_RESOURCE_SCENARIO_ALLOCATION_COST_REFRESH_FAILURE_HEADER", "RM_RESOURCE_SCENARIO_ALLOCATION_COST_REFRESH_FAILURE_DESC", "RM_RESOURCE_SCENARIO_COST_REFRESH_SUCCESS_HEADER", "RM_RESOURCE_SCENARIO_COST_REFRESH_SUCCESS_DESC", "RM_RESOURCE_DELETE_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "RM_RESOURCE_DELETE_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "RM_RESOURCE_DELETE_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "RM_RESOURCE_DELETE_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "RM_DEMAND_PROJECT_COST_REFRESH_SUCCESS_HEADER", "RM_DEMAND_PROJECT_COST_REFRESH_SUCCESS_DESC", "RM_DEMAND_PROJECT_COST_REFRESH_FAILURE_HEADER", "RM_DEMAND_PROJECT_COST_REFRESH_FAILURE_DESC", "RM_DEMAND_RESOURCE_ASSIGNMENT_FETCH_SUCCESS_HEADER", "RM_DEMAND_RESOURCE_ASSIGNMENT_FETCH_SUCCESS_DESC", "RM_DEMAND_RESOURCE_ASSIGNMENT_FETCH_FAILURE_HEADER", "RM_DEMAND_RESOURCE_ASSIGNMENT_FETCH_FAILURE_DESC", "STRATEGY_PROJECT_ALIGN_SCORE_REFRESH_SUCCESS_HEADER", "STRATEGY_PROJECT_ALIGN_SCORE_REFRESH_SUCCESS_DESC", "STRATEGY_PROJECT_ALIGN_SCORE_REFRESH_FAILURE_HEADER", "STRATEGY_PROJECT_ALIGN_SCORE_REFRESH_FAILURE_DESC", "STRATEGY_PROGRAM_ALIGN_SCORE_REFRESH_SUCCESS_HEADER", "STRATEGY_PROGRAM_ALIGN_SCORE_REFRESH_SUCCESS_DESC", "STRATEGY_PROGRAM_ALIGN_SCORE_REFRESH_FAILURE_HEADER", "STRATEGY_PROGRAM_ALIGN_SCORE_REFRESH_FAILURE_DESC", "WORKORDER_EMPTY_STATE_MESSAGE", "ADD_WBS_ASYNC_MESSAGE", "IDEA_SD_OWNER_ASSIGNED", "IDEA_MSG_OWNER_ASSIGNED", "IDEA_ACTION_SUBMITTED", "IDEA_ACTION_ASSIGNED", "IDEA_ACTION_ACCEPTED", "IDEA_ACTION_REJECTED", "IDEA_ACTION_REOPENED", "IDEA_ACTION_WITHDRAWN", "IDEA_ACTION_SET_AS_DRAFT", "IDEA_ACTION_PROPOSAL", "IDEA_SUBMITTED_HEADER", "IDEA_SUBMITTED_MESSAGE", "IDEA_ASSIGNED_HEADER", "IDEA_ASSIGNED_MESSAGE", "IDEA_ACCEPTED_HEADER", "IDEA_ACCEPTED_MESSAGE", "IDEA_REJECTED_HEADER", "IDEA_REJECTED_MESSAGE", "IDEA_REOPENED_HEADER", "IDEA_REOPENED_MESSAGE", "IDEA_WITHDRAWN_HEADER", "IDEA_WITHDRAWN_MESSAGE", "IDEA_SET_AS_DRAFT_HEADER", "IDEA_SET_AS_DRAFT_MESSAGE", "IDEA_PROPOSAL_HEADER", "IDEA_PROPOSAL_MESSAGE", "SOURCEID_EXISTS", "SUBMITTAL_REFRESH_LINK", "WORKSPACE_RESOURCE_VIEW_LINK", "PROJECT_RESOURCE_REFRESH_LINK", "PROJECT_ROLE_REFRESH_LINK", "RESOURCE_USAGE_EMPTY_STATE_MESSAGE", "ROLE_USAGE_EMPTY_STATE_MESSAGE", "RESOURCE_ROLE_USAGE_EMPTY_STATE_MESSAGE", "RESOURCE_ROLE_USAGE_SPREADSHEET_NO_DATA_AVAILABLE", "RESOURCE_USAGE_NO_VIEW_COST_PERMISSION", "ACTIVITY_USAGE_EMPTY_STATE_SPREADS_NO_ACTIVITY_MESSAGE", "ACTIVITY_USAGE_EMPTY_STATE_SPREADS_MESSAGE", "CSV_PROJECT_RESPONSE", "CSV_RESOURCE_RESPONSE", "CSV_BUDGET_ITEM_RESPONSE", "CSV_CBS_RESPONSE", "CSV_COMPANY_RESPONSE", "CSV_PROJECT_ACTUALS_RESPONSE", "CSV_PROJECT_ACTUALS_LINE_ITEM_RESPONSE", "CSV_CHANGE_ORDER_RESPONSE", "CSV_CHANGE_ORDER_LINE_ITEM_RESPONSE", "CSV_COMMITMENT_RESPONSE", "CSV_COMMITMENT_LINE_ITEM_RESPONSE", "CSV_USER_RESPONSE", "CSV_ERROR", "CSV_LABEL_FOR_REQUIRED", "CSV_LABEL", "INVESTOR_MAP_CHART_RENDER_ERROR", "PROJECT_VIEW_LINK", "DISABLE_SUBCATEGORY_MESSAGE", "ENABLE_SUBCATEGORY_MESSAGE", "PROJECT_CASHFLOW_VIEW_LINK", "PAGE_SETTINGS_REFRESH_ORIGINAL_PAGE", "PROGRAM_CASHFLOW_VIEW_LINK", "PROGRAM_VIEW_LINK", "CASHFLOW_SUB_CURVE_DISABLE_CONFIRMATION_MESSAGE", "CASHFLOW_SUB_CURVE_DISABLE_BOTH", "CASHFLOW_DISABLING_LINK_FORECAST_TO_ACTUALS_CONFIRMATION", "CASHFLOW_PROJECT_RESOURCE_COST_REFRESH_SUCCESS_HEADER", "CASHFLOW_PROJECT_RESOURCE_COST_REFRESH_SUCCESS_DESC", "CASHFLOW_PROJECT_RESOURCE_COST_REFRESH_FAILURE_HEADER", "CASHFLOW_PROJECT_RESOURCE_COST_REFRESH_FAILURE_DESC", "PROGRAM_COST_INSUFFICIENT_VIEW_PRIVILEGES", "TIMESHEET_USER_SUBMIT_INBOX_HEADER", "TIMESHEET_USER_SUBMIT_APPROVER_INBOX_DESCRIPTION", "TIMESHEET_USER_SUBMIT_SUPERVISOR_INBOX_DESCRIPTION", "TIMESHEET_SUBMIT_USER_INBOX_HEADER", "TIMESHEET_SUBMIT_USER_INBOX_DESCRIPTION", "TIMESHEET_MODIFY_SUBMIT_USER_INBOX_HEADER", "TIMESHEET_MODIFY_SUBMIT_USER_INBOX_DESCRIPTION", "TIMESHEET_SUBMIT_INBOX_HEADER", "TIMESHEET_SUBMIT_INBOX_DESCRIPTION", "TIMESHEET_MODIFY_SUBMIT_INBOX_HEADER", "TIMESHEET_MODIFY_SUBMIT_INBOX_DESCRIPTION", "TIMESHEET_APPROVE_USER_INBOX_HEADER", "TIMESHEET_APPROVE_USER_INBOX_DESCRIPTION", "TIMESHEET_APPROVE_SUPERVISOR_INBOX_HEADER", "TIMESHEET_APPROVE_SUPERVISOR_INBOX_DESCRIPTION", "TIMESHEET_REJECT_USER_INBOX_HEADER", "TIMESHEET_REJECT_USER_INBOX_DESCRIPTION", "TIMESHEET_REJECT_SUPERVISOR_INBOX_HEADER", "TIMESHEET_REJECT_SUPERVISOR_INBOX_DESCRIPTION", "TIMESHEET_REJECT_INBOX_COMMENT_SECTION", "TIMESHEET_REJECT_INBOX_NO_COMMENT", "TIMESHEET_VIEW_LINK", "TIMESHEET_WORKSPACE_SETTING_TIMEPERIODS_CREATED", "TIMESHEET_SUBMIT_CONFIRM", "TIMESHEETS_APPROVE_CONFIRM", "TIMESHEETS_REJECT_CONFIRM", "SM_SCHEDULE_BASELINE_SCENARIOS_SET_CURRENT_SCHEDULE", "EXTERNAL_EVENTS_SUBSCRIPTION_SUCCESSFUL", "EXTERNAL_EVENTS_UNSUBSCRIPTION_SUCCESSFUL", "PROGRAM_RISK_REGISTER_NO_VIEW_PRIVILEGES", "PROGRAM_EVALUATION_NO_TEMPLATE_EXISTS", "SM_SCHEDULE_COMPARISON_EMPTY_MESSAGE", "SM_SCHEDULE_COMPARISON_EMPTY_ACTIVITY_GRID_MESSAGE", "P6_XML_FAILED_ENTITY_IMPORT", "P6_XML_ENTITY_PROMOTE_FAILED_IGNORED", "P6_XML_ENTITY_PROMOTE_FAILED_IMPORT_ABORT", "P6_XML_ENTITY_PROMOTED_FROM_CHILD_WS_NO_UPDATE_REQUIRED", "P6_XML_ENTITY_PROMOTED_FROM_CHILD_WS_COPIED_PROJECT_CALENDAR", "P6_XML_ENTITY_PROMOTED_FROM_CHILD_WS_ENTITY_UPDATED", "P6_XML_ENTITY_FOUND_ADDED_TO_CURRENT_WS_NO_UPDATE", "P6_XML_ENTITY_FOUND_ADDED_TO_CURRENT_WS_CANNOT_UPDATE", "P6_XML_ENTITY_NOT_FOUND_CANNOT_CREATE_IN_CURRENT_WORKSPACE", "P6_XML_ENTITY_NOT_FOUND_CREATED_NEW", "P6_XML_ENTITY_CREATED_NEW", "P6_XML_WBS_SUMMARY_ACTIVITY", "P6_XML_PROJECT_WBS_ASSIGNMENT", "P6_XML_ENTITY_FOUND_INSERT_NEW_OPTION_CREATED_NEW", "P6_XML_MULTIPLE_entity_FOUND_NEW_ENTITY_CREATED", "P6_XML_ENTITY_FOUND_IGNORE_CONFIGURED_USED_EXISTING", "P6_XML_ENTITY_FOUND_UPDATE_BASELINE_CONFIGURED_USED_EXISTING", "P6_XML_ENTITY_UPDATE_BASELINE_CONFIGURED_USED_EXISTING_PROJECT", "P6_XML_ENTITY_NOT_FOUND_UPDATE_BASELINE_CONFIGURED_IGNORED", "P6_XML_ENTITY_NOT_FOUND_IGNORE_CONFIGURED_IGNORED", "P6_XML_ENTITY_HAS_ENTITY_AS_IGNORED_CONFIGURED_IGNORED", "P6_XML_ENTITY_HAS_ENTITY_AS_IGNORED_ON_IMPORT_CONFIGURED_IGNORED", "P6_XML_ENTITY_HAS_ENTITY_AS_UPDATE_BASELINE_ONLY_CONFIGURED_IGNORED", "P6_XML_ENTITY_FOUND_UPDATE_EXISTING_UPDATED", "P6_XML_ENTITY_UPDATE_EXISTING_UPDATED", "P6_XML_ENTITY_IMPORT_FAIL", "P6_XML_ENTITY_FOUND_KEEP_EXISTING_CONFIGURED_USED_EXISTING", "P6_XML_ENTITY_NOT_FOUND_IGNORE_CONFIGURED_USED", "P6_XML_ENTITY_REMOVED_FROM_PRIME", "P6_XML_ENTITY_RESOURCE_ROLE_IGNORED_ASSIGNMENT_IGNORED", "P6_XML_ENTITY_RISK_SCORE_TYPE_IGNORED_RISK_IGNORED", "P6_XML_ENTITY_RISK_IGNORED_RISK_MITIGATION_IGNORED", "P6_XML_ACTIVITY_DEPENDENT_IGNORED", "P6_XML_ENTITY_RISK_SCORE_TYPE_IGNORED_RISKMATRIX_IGNORED", "P6_XML_ENTITY_RISK_MATRIX_IGNORED_RISK_IGNORED", "P6_XML_ACTIVITY_WBS_SCOPE_RULE_IGNORED", "P6_XML_DUPLICATE_RELATIONSHIP", "P6_XML_ACTIVITY_MILESTONE_ASSG_RULE_IGNORED", "P6_XML_ENTITY_CURVE_IGNORED", "P6_XML_ENTITY_ACTUAL_CURVE_IGNORED", "P6_XML_ENTITY_FOUND_HIERARCHY_EXIST_NOT_IMPORTED", "P6_XML_ENTITY_ACTIVITY_TYPE_MILESTONE", "P6_XML_ENTITY_ASSIGNMENT_TYPE_DEFAULT", "P6_XML_ENTITY_ASSIGNMENT_DUPLICATE", "P6_XML_ENTITY_ASSIGNMENT_RESOURCEROLE_NOT_FOUND", "P6_XML_ENTITY_ASSIGNMENT_RESOURCE_ROLE_ACTUAL_UNIT_EXIST", "P6_XML_ENTITY_NOT_REMOVED_TIMESHEET_HOURS_APPROVED", "P6_XML_UOM_NOT_IMPORTED", "P6_XML_ENTITY_FOUND_NOT_IMPORT_TYPE_MISMATCH", "P6_XML_IMPORT_FAILED_CONSTRAINT_CONFLICT", "P6_XML_IMPORT_FAILED_EXCEPTION_CONFLICT", "P6_XML_RESOURCE_FOUND_NO_ASSIGNMENT", "P6_XML_RESOURCE_TYPE_MISMATCH", "P6_XML_PRIMAVERA_CLOUD_BASELINE_EXISTS_IGNORED", "P6_XML_CANNOT_UPDATE_FORMULA_UDF", "P6_XML_ENTITY_FOUND_AFTER_TRUNCATE", "P6_XML_DUPLICATE_ROLE_ID_PRESENT", "P6_XML_DUPLICATE_UDF_PRESENT", "P6_XML_EMPTY_UDF_LABEL", "P6_XML_CREATE_NEW_IMPORT_OPTION", "P6_XML_UPDATE_EXISTING_IMPORT_OPTION", "P6_XML_KEEP_EXISTING_IMPORT_OPTION", "P6_XML_IGNORE_IMPORT_OPTION", "P6_XML_IMPORT_PROJECT_AND_WBS_NOTES", "P6_XML_UPDATE_BASELINE_SCENARIO_ONLY_IMPORT_OPTION", "P6_XML_BASELINE_SCENARIO_ENTITY_IGNORE_CONFIGURED", "P6_XML_ENTITY_IGNORED", "ACTIVITY_RENUMBER_FAILED", "ACTIVITY_RENUMBER_SUCCESSFUL", "ACTIVITY_RENUMBER_FAIL_DESCRIPTION", "ACTIVITY_RENUMBER_SUCCESS_DESCRIPTION", "ACTIVITY_RENUMBER_NO_PROJECT_PRIVILEGE", "ACTIVITY_RENUMBER_NO_ACTIVITY_EDIT_PRIVILEGE", "ACTIVITY_RENUMBER_NO_BASELINE_ACTIVITY_EDIT_PRIVILEGE", "UDF_DEL_INVALID_LABEL", "UDF_DEL_INVALID_NAME", "UDF_DEL_INVALID_ID", "UDF_DEL_INVALID_ASSIGNMENT_ID", "INVALID_CHILD_DEL", "EXCEL_IMPORT_SUCCES_CUSTOM_LOG", "EXCEL_IMPORT_FAILED_CUSTOM_LOG", "EXCEL_IMPORT_TERMINATED_CUSTOM_LOG", "PORTFOLIO_PRIORITIZATION_MATRIX_VIEW_LINK", "BUDGET_TRANSACTION_DEL_INVALID_TRANSACTION_ID", "PROJECT_CALENDAR_DELETE", "SCORECARD_VIEW_LINK", "THRESHOLD_SUB_CAT_PROMPT_BOX_TITLE", "THRESHOLD_SUB_CAT_PROMPT_BOX_MSG", "MOVE_LOG_BASELINE_CATEGORY_ENTITY", "MOVE_LOG_CALENDAR_ENTITY", "MOVE_LOG_CODE_ENTITY", "MOVE_LOG_NOTEBOOK_ENTITY", "MOVE_LOG_CURVE_ENTITY", "MOVE_LOG_PERMISSION_ENTITY", "MOVE_LOG_REASON_ENTITY", "MOVE_LOG_FLEX_FIELD_ENTITY", "MOVE_LOG_COLUMN_DEFINITION_FIELD_RELATIONSHIP_ENTITY", "MOVE_LOG_REPORT_ENTITY", "MOVE_LOG_RESOURCE_ENTITY", "MOVE_LOG_PROJECTRESOURCE_ENTITY", "MOVE_LOG_ROLE_ENTITY", "MOVE_LOG_PROJECTROLE_ENTITY", "MOVE_LOG_COST_CATEGORY_ENTITY", "MOVE_LOG_WORKFLOW_ENTITY", "MOVE_INACCESSIBLE_WORKFLOW", "MOVE_INACCESSIBLE_RUNNING_WORKFLOW", "MOVE_LOG_CUSTOM_LOG_ENTITY", "MOVE_LOG_PROJECT_CUSTOM_LOG_ENTITY", "MOVE_LOG_RULE_OF_CREDIT_ENTITY", "MOVE_LOG_UNITS_OF_MEASURE_ENTITY", "MOVE_LOG_CURRENCY_ENTITY", "MOVE_LOG_FORMS_ENTITY", "MOVE_LOG_EVALUATION_MATRIX_ENTITY", "MOVE_LOG_PROGRAM_ENTITY", "MOVE_LOG_INSIGHT_MODEL_ENTITY", "MOVE_LOG_CBSSHEET_CODE_ENTITY", "MOVE_LOG_CBS_ENTITY", "MOVE_LOG_DASHBOARD_ENTITY", "MOVE_LOG_REPORT_CYCLE_ENTITY", "MOVE_LOG_PRINTLAYOUT_ENTITY", "MOVE_LOG_PROJ_USER_GROUP_ENTITY", "MOVE_LOG_WS_USER_GROUP_ENTITY", "MOVE_LOG_PROJECT_DASHBOARD_ENTITY", "MOVE_LOG_BASELINE_CATEGORY", "MOVE_LOG_CALENDAR", "MOVE_LOG_CODE", "MOVE_LOG_NOTEBOOK_TOPIC", "MOVE_LOG_CURVE", "MOVE_LOG_PERMISSION", "MOVE_LOG_REASON", "MOVE_LOG_FLEX_FIELD", "MOVE_LOG_REPORT", "MOVE_LOG_PRINTLAYOUT", "MOVE_LOG_RESOURCE", "MOVE_LOG_PROJECTRESOURCE", "MOVE_LOG_PROJECTRESOURCE_LOWER_CASE", "MOVE_LOG_PROJECTROLE_LOWER_CASE", "MOVE_LOG_ROLE", "MOVE_LOG_PROJECTROLE", "MOVE_LOG_COST_CATEGORY", "MOVE_LOG_COST_CATEGORY_LOWER_CASE", "MOVE_LOG_CUSTOM_LOG", "MOVE_LOG_UNITS_OF_MEASURE", "MOVE_LOG_CURRENCY", "MOVE_LOG_RULE_OF_CREDIT", "MOVE_LOG_RULE_OF_CREDIT_LOWER_CASE", "MOVE_LOG_EVALUATION_MATRIX", "MOVE_LOG_PROGRAM", "MOVE_LOG_INSIGHT_MODEL", "MOVE_LOG_CBSSHEET_CODE", "MOVE_LOG_DASHBOARD", "MOVE_LOG_REPORT_CYCLE", "MOVE_LOG_USER_GROUP", "MOVE_LOG_PROJECT_DASHBOARD", "MOVE_LOG_PROJECT_DASHBOARD_LOWER_CASE", "MOVE_LOG_WORKFLOW", "MOVE_WORKSPACE_LOG_REPORT_ENTITY", "MOVE_WORKSPACE_OWNED_ENTITY", "MOVE_WORKSPACE_INHERITED_ENTITY", "MOVE_PROJECT_SHARED_ENTITY_PULLED_DOWN", "MOVE_PROJECT_SHARED_ENTITY_PROMOTED", "MOVE_PROJECT_SHARED_ENTITY_PROMOTED_AND_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_PROMOTED_ID_NAME_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_ONLY_PROMOTED", "MOVE_PROJECT_SHARED_ENTITY_ONLY_PROMOTED_AND_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_ONLY_PROMOTED_ID_NAME_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_NOT_UPDATED", "MOVE_PROJECT_SHARED_ENTITY_REMOVED", "MOVE_PROJECT_SHARED_ENTITY_COPIED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_RES_ROLE_IGNORED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_AND_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_AND_RENAMED_RES_ROLE_IGNORED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_ID_NAME_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_ID_NAME_RENAMED_RES_ROLE_IGNORED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_ID_NAME_RENAMED_EXISTING_UDF_COPIED", "MOVE_PROJECT_RESTRICTED_ENTITY_ASSOCIATED", "MOVE_PROJECT_CUSTOM_LOG_RESTRICTED_ENTITY_ASSOCIATED", "MOVE_PROJECT_RESOURCE_ID_RENAMED", "MOVE_PROJECT_ROLE_ID_RENAMED", "MOVE_PROJECT_REPORT_MOVED", "MOVE_PROJECT_REPORT_ID_RENAMED", "MOVE_PROJECT_EVALUATION_CATEGORY_REMOVED", "MOVE_PROJECT_WS_USER_GROUP_REMOVED", "MOVE_PROJECT_PROJ_USER_GROUP_REMOVED", "MOVE_PROJECT_USER_GROUP_UNCHANGED", "MOVE_PROJECT_PROJ_CUSTOM_LOG_RENAMED", "MOVE_PROJECT_PRINTLAYOUT_UNCHANGED", "MOVE_PROJECT_PROJECT_REMOVED_FROM_PROGRAM", "MOVE_PROJECT_CBS_CODE_COPIED_TO_PROJECT", "MOVE_PROJECT_SUCCESS", "MOVE_PROJECT_FAIL", "PROJECT_MOVE_FAILED_EXCEPTION_CONFLICT", "PROJECT_MOVE_FAILED_CONSTRAINT_CONFLICT", "PROJECT_MOVE_FAILED", "PROJECT_MOVE_FAILED_SUMMARY", "WORKSPACE_COUNT_MOVED", "PROJECT_COUNT_MOVED", "FUND_COUNT_MOVED", "PORTFOLIO_COUNT_MOVED", "SAME_FORMULA_UDF_IS_EXISTING", "ANALYSIS_VIEW_COUNT_MOVED", "IDEA_COUNT_MOVED", "IDEA_COUNT_RENAMED", "CALENDAR_COUNT_MOVED", "CALENDAR_COUNT_COPIED", "CALENDAR_COUNT_UNCHANGED", "CALENDAR_MOVE_COUNT_FAILED", "CALENDAR_COUNT_AUTOMATICALLY_HANDLED", "CALENDAR_COUNT_RENAMED", "COST_CATEGORY_COUNT_FAILED", "COST_CATEGORY_COUNT_UNCHANGED", "COST_CATEGORY_COUNT_MOVED", "COST_CATEGORY_COUNT_COPIED", "COST_CATEGORY_COUNT_AUTOMATICALLY_HANDLED", "WORKFLOW_COUNT_FAILED", "WORKFLOW_COUNT_UNCHANGED", "WORKFLOW_COUNT_MOVED", "WORKFLOW_COUNT_COPIED", "WORKFLOW_COUNT_AUTOMATICALLY_HANDLED", "CUSTOM_LOG_COUNT_FAILED", "CUSTOM_LOG_COUNT_UNCHANGED", "CUSTOM_LOG_COUNT_MOVED", "CUSTOM_LOG_COUNT_COPIED", "CUSTOM_LOG_COUNT_AUTOMATICALLY_HANDLED", "PROJECT_CUSTOM_LOG_COUNT_MOVED", "PROJECT_CUSTOM_LOG_COUNT_COPIED", "PROJECT_CUSTOM_LOG_COUNT_UNCHANGED", "PROJECT_CUSTOM_LOG_COUNT_AUTOMATICALLY_HANDLED", "RULE_OF_CREDIT_COUNT_FAILED", "RULE_OF_CREDIT_COUNT_UNCHANGED", "RULE_OF_CREDIT_COUNT_MOVED", "RULE_OF_CREDIT_COUNT_RENAMED", "RULE_OF_CREDIT_COUNT_REMOVED", "RULE_OF_CREDIT_COUNT_COPIED", "RULE_OF_CREDIT_COUNT_AUTOMATICALLY_HANDLED", "CODE_COUNT_MOVED", "CODE_COUNT_COPIED", "CODE_COUNT_UNCHANGED", "CODE_COUNT_MOVE_FAILED", "CODE_COUNT_AUTOMATICALLY_HANDLED", "NOTEBOOK_COUNT_MOVED", "NOTEBOOK_COUNT_COPIED", "NOTEBOOK_COUNT_UNCHANGED", "NOTEBOOK_COUNT_MOVE_FAILED", "NOTEBOOK_COUNT_AUTOMATICALLY_HANDLED", "FOLDER_TEMPLATE_COUNT_MOVED", "FOLDER_TEMPLATE_COUNT_RENAMED", "FOLDER_TEMPLATE_COUNT_REMOVED", "FLEX_FIELD_COUNT_MOVED", "FLEX_FIELD_COUNT_COPIED", "FLEX_FIELD_COUNT_UNCHANGED", "FLEX_FIELD_COUNT_AUTOMATICALLY_HANDLED", "FLEX_FIELD_MOVE_COUNT_FAILED", "PERMISSION_COUNT_MOVED", "PERMISSION_COUNT_COPIED", "PERMISSION_COUNT_UNCHANGED", "PERMISSION_COUNT_MOVE_FAILED", "PERMISSION_COUNT_AUTOMATICALLY_HANDLED", "REPORT_COUNT_MOVED", "REPORT_COUNT_COPIED", "REPORT_COUNT_UNCHANGED", "REPORT_COUNT_AUTOMATICALLY_HANDLED", "REPORT_COUNT_MOVE_FAILED", "WS_RESOURCE_COUNT_MOVED", "WS_RESOURCE_COUNT_RENAMED", "WS_RESOURCE_COUNT_COPIED", "WS_RESOURCE_COUNT_UNCHANGED", "WS_RESOURCE_COUNT_MOVE_FAILED", "WS_RESOURCE_COUNT_AUTOMATICALLY_HANDLED", "WSMOVE_RESOURCE_COUNT_MOVED", "WSMOVE_RESOURCE_COUNT_RENAMED", "PR_RESOURCE_COUNT_MOVED", "PR_RESOURCE_COUNT_COPIED", "PR_RESOURCE_COUNT_UNCHANGED", "PR_RESOURCE_COUNT_AUTOMATICALLY_HANDLED", "PR_RESOURCE_COUNT_MOVE_FAILED", "WS_ROLE_COUNT_MOVED", "WS_ROLE_COUNT_RENAMED", "WS_ROLE_COUNT_COPIED", "WS_ROLE_COUNT_UNCHANGED", "WS_ROLE_COUNT_MOVE_FAILED", "WS_ROLE_COUNT_AUTOMATICALLY_HANDLED", "WSMOVE_ROLE_COUNT_MOVED", "WSMOVE_ROLE_COUNT_RENAMED", "WSMOVE_ROLE_COUNT_REMOVED", "PR_ROLE_COUNT_MOVED", "PR_ROLE_COUNT_COPIED", "PR_ROLE_COUNT_UNCHANGED", "PR_ROLE_COUNT_AUTOMATICALLY_HANDLED", "PR_ROLE_COUNT_MOVE_FAILED", "CURVE_COUNT_MOVED", "CURVE_COUNT_COPIED", "CURVE_COUNT_UNCHANGED", "CURVE_COUNT_MOVE_FAILED", "CURVE_COUNT_AUTOMATICALLY_HANDLED", "REASON_COUNT_MOVED", "REASON_COUNT_COPIED", "REASON_COUNT_UNCHANGED", "REASON_COUNT_MOVE_FAILED", "REASON_COUNT_AUTOMATICALLY_HANDLED", "MEASURE_COUNT_MOVED", "UNITS_OF_MEASURE_COUNT_MOVED", "UNITS_OF_MEASURE_COUNT_COPIED", "UNITS_OF_MEASURE_COUNT_UNCHANGED", "UNITS_OF_MEASURE_COUNT_FAILED", "UNITS_OF_MEASURE_COUNT_AUTOMATICALLY_HANDLED", "UNITS_OF_MEASURE_COUNT_RENAMED", "UNITS_OF_MEASURE_COUNT_REMOVED", "INSIGHT_MODEL_COUNT_MOVED", "INSIGHT_MODEL_COUNT_COPIED", "INSIGHT_MODEL_COUNT_UNCHANGED", "INSIGHT_MODEL_MOVE_COUNT_FAILED", "INSIGHT_MODEL_COUNT_AUTOMATICALLY_HANDLED", "DASHBOARD_COUNT_MOVED", "DASHBOARD_COUNT_COPIED", "DASHBOARD_COUNT_UNCHANGED", "DASHBOARD_MOVE_COUNT_FAILED", "DASHBOARD_COUNT_AUTOMATICALLY_HANDLED", "PS_DASHBOARD_COUNT_MOVED", "PS_DASHBOARD_COUNT_COPIED", "PS_DASHBOARD_COUNT_UNCHANGED", "PS_DASHBOARD_COUNT_AUTOMATICALLY_HANDLED", "MOVE_PROJECT_DASHBOARD_ID_RENAMED", "DASHBOARD_ONLY_COUNT_MOVED", "REPORT_CYCLE_COUNT_RENAMED", "REPORT_CYCLE_COUNT_MOVED", "REPORT_CYCLE_COUNT_COPIED", "REPORT_CYCLE_COUNT_UNCHANGED", "REPORT_CYCLE_MOVE_COUNT_FAILED", "REPORT_CYCLE_COUNT_AUTOMATICALLY_HANDLED", "CURRENCY_COUNT_MOVED", "CURRENCY_COUNT_COPIED", "CURRENCY_COUNT_AUTOMATICALLY_HANDLED", "CURRENCY_COUNT_UNCHANGED", "EVALUATION_MATRIX_COUNT_REMOVED", "EVALUATION_MATRIX_COUNT_RENAMED", "EVALUATION_MATRIX_NO_TEMPLATE_EXISTS", "EVALUATION_MATRIX_ACTIVATE_INFO_BANNER", "EVALUATION_MATRIX_COUNT_MOVED", "EVALUATION_MATRIX_COUNT_COPIED", "EVALUATION_MATRIX_COUNT_AUTOMATICALLY_HANDLED", "EVALUATION_MATRIX_COUNT_UNCHANGED", "DECREASED_RANK_SCALE_DIALOG_TEXT", "PROGRAM_COUNT_RENAMED", "PROGRAM_COUNT_MOVED", "PROGRAM_COUNT_COPIED", "PROGRAM_COUNT_UNCHANGED", "PROGRAM_COUNT_AUTOMATICALLY_HANDLED", "PROGRAM_COUNT_MOVE_FAILED", "WS_USER_GROUP_COUNT_MOVED", "WS_USER_GROUP_COUNT_COPIED", "WS_USER_GROUP_COUNT_AUTOMATICALLY_HANDLED", "WS_USER_GROUP_COUNT_UNCHANGED", "PROJ_USER_GROUP_COUNT_MOVED", "PROJ_USER_GROUP_COUNT_COPIED", "PROJ_USER_GROUP_COUNT_UNCHANGED", "PROJ_USER_GROUP_COUNT_AUTOMATICALLY_HANDLED", "VIEW_COUNT_MOVED", "VIEW_COUNT_RENAMED", "FILTER_COUNT_MOVED", "FILTER_COUNT_RENAMED", "STRATEGY_COUNT_MOVED", "CBS_COUNT_REMOVED", "CBS_COUNT_RENAMED", "CBS_COUNT_MOVED", "CBSSHEET_CODE_COUNT_MOVED", "CBSSHEET_CODE_COUNT_COPIED", "CBSSHEET_CODE_COUNT_UNCHANGED", "CBSSHEET_CODE_COUNT_AUTOMATICALLY_HANDLED", "CURRENCY_RECALCULATION_SUCCESS_TITLE", "CURRENCY_RECALCULATION_SUCCESS_DESCRIPTION", "CURRENCY_RECALCULATION_FAIL_TITLE", "CURRENCY_RECALCULATION_FAIL_DESCRIPTION", "CURRENCY_RECALCULATION_INPROGRESS_TITLE", "CURRENCY_RECALCULATION_INPROGRESS_DESCRIPTION", "CURRENCY_RECALCULATION_UPDATE_FAILED", "PRINTLAYOUT_COUNT_MOVED", "PRINTLAYOUT_COUNT_COPIED", "PRINTLAYOUT_COUNT_UNCHANGED", "PRINTLAYOUT_COUNT_AUTOMATICALLY_HANDLED", "PRINTLAYOUT_REMOVED", "WORKSPACE_MOVE_RISK_MATRIX_COUNT_MOVED", "WORKSPACE_MOVE_RISK_MATRIX_COUNT_RENAMED", "WORKSPACE_MOVE_RISK_SCORE_TYPE_COUNT_MOVED", "WORKSPACE_MOVE_RISK_SCORE_TYPE_COUNT_RENAMED", "BASELINE_CATEGORY_COUNT_MOVED", "BASELINE_CATEGORY_COUNT_COPIED", "BASELINE_CATEGORY_COUNT_UNCHANGED", "BASELINE_CATEGORY_COUNT_AUTOMATICALLY_HANDLED", "BASELINE_CATEGORY_COUNT_FAILED", "API_ACCESS_RESTRICTED", "API_DUPLICATE_RECORDS_FOUND_CHECK_CHILD_RESPONSES", "API_MULTIPLE_NESTED_ENTITES_FOR_SAME_DB_ENTRY_SENT", "API_PROJECT_RISK_SCORE_TYPE_THRESHOLDS_COUNT_CHANGE_NOT_MODIFIED", "API_RISK_ANALYSIS_ALREADY_IN_PROGRESS_CANNOT_TRIGGER_NEW_RUN", "API_RISK_MATRIX_SCORE_NOT_FOUND_TO_DELETE", "API_RISK_MATRIX_SCORE_TYPE_NOT_FOUND_TO_DELETE", "API_RISK_MATRIX_TOLERANCE_NOT_FOUND_TO_DELETE", "API_RISK_REQUIRED_FIELD", "API_RISK_SCORE_THRESHOLD_NOT_FOUND_TO_DELETE", "API_RULE_OF_CREDIT_MILESTONE_NOT_FOUND_TO_DELETE", "API_WBS_IMPORT_RUNNING_IN_BACKGROUND", "API_UNSUPPORTED_PROJECTION_FORMAT_SPECIFIED", "INVALID_USER_PAYLOAD", "USER_NOT_PRESENT_IN_USERGROUP_OR_INHERITED", "USER_ALREADY_PRESENT", "INVALID_CUSTOMLOG_USER", "MISSING_MANDATORY_PERMISSIONSET", "INVALID_PROJECT_PERMISSIONSET", "INVALID_CUSTOMLOG_PERMISSIONSET", "INVALID_DOCUMENT_PERMISSIONSET", "INVALID_REPORT_PERMISSIONSET", "INVALID_WORKSPACE_PERMISSIONSET", "INVALID_PROGRAM_PERMISSIONSET", "INVALID_PORTFOLIO_PERMISSIONSET", "INVALID_IDEA_PERMISSIONSET", "INVALID_GLOBAL_PERMISSIONSET", "INVALID_GLOBAL_PERMISSIONSET_ASSIGNMENT", "INVALID_ENTITY_SCOPE", "VALID_ASSIGNMENT", "INVALID_UG_PAYLOAD", "UG_INVALID_PROJECT_PERMISSIONSET", "UG_INVALID_CUSTOMLOG_PERMISSIONSET", "UG_INVALID_DOCUMENT_PERMISSIONSET", "UG_INVALID_REPORT_PERMISSIONSET", "UG_INVALID_WORKSPACE_PERMISSIONSET", "UG_INVALID_PROGRAM_PERMISSIONSET", "UG_INVALID_PORTFOLIO_PERMISSIONSET", "UG_INVALID_IDEA_PERMISSIONSET", "USAGE_IN_USER_GROUP", "RESET_ALL_USERS", "REMOVE_USERS_API_GATEWAY_ACCESS", "SAVE_NO_USERS", "API_USER_ACCESS_REMOVE_MESSAGE", "RESET_ALL_ADDRESSES", "API_IP_ACCESS_REMOVE_MESSAGE", "REMOVE_COMBINED_API_GATEWAY_ACCESS", "EXPORT_ENTIRE_SPREAD_EXPORT_SUCCESS", "EXPORT_ENTIRE_SPREAD_EXPORT_FAIL", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_SUCCESS_PROJECT", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_FAIL_PROJECT", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_SUCCESS_PROGRAM", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_FAIL_PROGRAM", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_SUCCESS_WORKSPACE", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_SUCCESS_MULTIPLE_PROJECTS", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_FAIL_WORKSPACE", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_FAIL_MULTIPLE_PROJECTS", "PROJECT_MIGRATION_FAILED", "PROJECT_MIGRATION_SUMMARY", "MIGRATION_COUNT_FAILED", "DELETE_WBS_CONFIRMATION_MESSAGE", "DELETE_WBS_REASSIGN_ASSOCIATED_ACTIVITIES_TASKS", "OIC_CONNECTION_LOAD_FAIL" ] }, "stepName":{ "type":"string", "description":"Specifies the step name the workflow is on. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "taskName":{ "type":"string", "description":"Specifies the task name associated with the step the workflow is on. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "description":{ "type":"string", "description":"Specifies the description of the task associated with the step the workflow is on.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "GLOBAL_ARE_YOU_SURE_YOU_WANT_TO_CANCEL", "GLOBAL_CONFIRM_DELETE_GRID_ROW", "GLOBAL_CONFIRM_ENABLE_GRID_ROW", "GLOBAL_CONFIRM_DELETE_REPORT_LAYOUT", "GLOBAL_UNSAVED_CHANGES_CONFIRM", "GLOBAL_UNSAVED_CHANGES", "GLOBAL_MAINTENANCE_INFORMATION", "GLOBAL_MAINTENANCE_STATUS", "GLOBAL_MAINTENANCE_STATUS_PAGE", "GRID_PRINT_COMPLETE", "GRID_PRINT_RENDER_IN_BACKGROUND", "FAILED_TO_PRINT_GRID", "EXCEL_IMPORT_SUCCES", "EXCEL_IMPORT_FAILED", "EXCEL_IMPORT_TERMINATED", "EXCEL_IMPORT_SUCCES_WORKSPACE", "EXCEL_IMPORT_SUCCES_PORTFOLIO", "EXCEL_IMPORT_FAILED_WORKSPACE", "EXCEL_IMPORT_FAILED_PORTFOLIO", "EXCEL_IMPORT_TERMINATED_WORKSPACE", "EXCEL_IMPORT_TERMINATED_PORTFOLIO", "EXCEL_IMPORT_SUCCES_PROGRAM", "EXCEL_IMPORT_FAILED_PROGRAM", "EXCEL_IMPORT_TERMINATED_PROGRAM", "EXCEL_IMPORT_UNRECOVERABLE_FAIL", "EXCEL_IMPORT_COMMENT_FIRST_ROW", "EXCEL_IMPORT_COMMENT_SECOND_ROW", "EXCEL_IMPORT_ERROR_COLUMN", "EXCEL_IMPORT_ERROR_EMPTY_SHEET", "EXCEL_UNRECOVERABLE_ERROR_COLUMN_NAME", "EXCEL_DOWNLOAD_READY", "EXCEL_DOWNLOAD_FAILED_CONTEXT", "EXCEL_DOWNLOAD_FAILED_MESSAGE", "GENERIC_IMPORT_ERR_REJECTED_COLUMN", "GENERIC_IMPORT_ERR_REJECTED_ROW", "GENERIC_IMPORT_SUCCESSFUL", "GENERIC_COST_PRIVILEGE_WARNING", "LOGIN_COPYRIGHT_HEADER", "CONFIRM_LOGOUT_PAGE_CONFIRMATION", "CONFIRM_FORMULA_TO_MANUAL_NO_ASSIGNMENTS", "TRADEMARK_NOTICE", "SESSIONTIMEOUT_EXPIRED_MESSAGE", "SESSIONTIMEOUT_SIGNBACK_MESSAGE", "UDF_CREATE_FAILED", "UDF_CREATE_SUCCESS", "UDF_CREATE_SUCCESS_MESSAGE", "UDF_REFRESH_WARNING", "EXPORT_SUCCESS", "EXPORT_FAIL", "SCHEDULE_COMPARISON_EXPORT_SUCCESS", "SCHEDULE_COMPARISON_EXPORT_FAIL", "MSP_EXPORT_SUCCESS", "MSP_EXPORT_FAIL", "EXPORT_PRIMAVERA_CLOUD_PROJ_DATA_TO_MSP", "VALIDATION_NUMBER_BETWEEN", "VALIDATION_NUMBER_STRICTLY_WITHIN", "NEWSFEED_DOCUMENTS_CREATE_DOCUMENT", "NEWSFEED_DOCUMENTS_CREATE_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_CREATE_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_CREATE_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_DOCUMENTS_UPDATE_DOCUMENT", "NEWSFEED_DOCUMENTS_UPDATE_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_UPDATE_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_UPDATE_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_DOCUMENTS_DELETE_DOCUMENT", "NEWSFEED_DOCUMENTS_DELETE_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_DELETE_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_DELETE_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_DOCUMENTS_CHECKIN_DOCUMENT", "NEWSFEED_DOCUMENTS_CHECKIN_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_CHECKIN_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_CHECKIN_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_DOCUMENTS_CHECKOUT_DOCUMENT", "NEWSFEED_DOCUMENTS_CHECKOUT_DOCUMENT_PROXY", "NEWSFEED_DOCUMENTS_CHECKOUT_DOCUMENT_NO_ENTITY", "NEWSFEED_DOCUMENTS_CHECKOUT_DOCUMENT_NO_ENTITY_PROXY", "NEWSFEED_BUDGET_APPROVED_MESSAGE", "NEWSFEED_RESOURCE_APPROVED_MESSAGE", "NEWSFEED_BUDGET_PROPOSED_MESSAGE", "TOTAL_ALLOCATION_UNITS_LESS_ARE_LESS", "VALIDATION_UNIQUE", "VALIDATION_REQUIRED", "VALIDATION_STARTDATE_AFTER_FINISHDATE", "VALIDATION_FINISHDATE_BEFORE_STARTDATE", "VALIDATION_STARTDATE_EMPTY", "VALIDATION_FINISHDATE_EMPTY", "VALIDATION_STARTDATE_BEFORE_FY_YEAR", "FILTER_FIELD_NOT_RECOGNIZED", "FILTER_FIELD_UNAVAILABLE", "FILTER_FIELD_NO_RECOGNIZED_VALUE", "FILTER_FIELD_BAD_VALUE", "FILTER_FIELD_CODE_DOESNT_EXIST", "FILTER_FIELD_DELETED", "FILTER_FIELD_VALUE_DELETED", "FILTER_FIELD_CODE_NAME_UNKNOWN", "FILTER_FIELD_OBJECT_UNKNOWN", "UDF_INDICATOR_HIGHVALUE_TOO_LOW", "UDF_FORMULA_VALIDATION_PASSED", "PROJECTPICKER_GROUP_BY_WORKSPACE", "PROJECTPICKER_GROUP_BY_PROJECT_CODES", "CP_MONITORINGTHRESHOLDS_CONFIRM_DELETE", "CP_MONITORSCORECARD_NO_APPROVED_SCENARIO", "CP_PROJECTINVENTORY_CONFIRM_DELETE", "CP_PROJECTINVENTORY_CONFIRM_DELETE_WORKSPACE_WITH_CHILDREN", "CP_PROJECTINVENTORY_CONFIRM_DELETE_WORKSPACE", "CP_PROJECTINVENTORY_CONFIRM_DELETE_PROJECT", "CP_PROJECTINVENTORY_EXCHANGE_RATE_LOCKED", "CP_PROJECTINVENTORY_ADD_PROJECT_UNIQUE", "CP_PROJECTINVENTORY_CANNOT_SWITCH_GROUPING", "CP_PROJECTINVENTORY_DELETE_PERMANENTLY", "CP_PROJECTINVENTORY_MARK_AS_INACTIVE", "CP_PROJECTINVENTORY_ARCHIVE", "CP_PROJECTINVENTORY_CONFIRM_REMOVE_PROJECTS_MAPPED_TO_SCOPE_OR_CP", "CP_PROJECTINVENTORY_TEMPLATE_RUNNING_ASYNC", "SELECT_FIELDS_INSTRUCTIONS", "CP_MANAGEWORKSPACES_CONFIRM_DELETE_WORKSPACE", "CP_CAPITALPORTFOLIOINVENTORY_CONFIRM_DELETE_WITH_PLANS", "CP_CAPITALPORTFOLIOINVENTORY_CONFIRM_DELETE_NO_PLANS", "CP_CAPITALPORTFOLIOINVENTORY_PLANNING_HORIZON_DESC", "CP_CAPITALPORTFOLIOINVENTORY_NOT_ENABLED", "CP_CAPITALPORTFOLIOINVENTORY_ENABLE_CAPITAL_PLAN_HELP", "PROJECT_PORTFOLIO_REMOVE_MANUALLY_ADDED_ALERT", "CP_BUDGETPLANNING_OPTIMIZATION_MESSAGE_SINGLE", "CP_BUDGETPLANNING_OPTIMIZATION_MESSAGE_PLURAL", "CP_BUDGETPLANNING_OPTIMIZATION_MESSAGE_AND", "CP_BUDGETPLANNING_OPTIMIZATION_SUGGESTION", "CP_BUDGETPLANNING_OPTIMIZATION_SAVE", "CP_BUDGETPLANNING_OPTIMIZATION_FAILURE", "CP_BUDGETPLANNING_PLAN_PERIOD_CONFIRMATION", "CP_BUDGETPLANNING_SWITCH_SCENARIO_CONFIRMATION", "CP_BUDGETCHANGEDETAILS_CONFIRMATION", "CP_BUDGETCHANGEDETAILS_APPROVE_CONFIRMATION", "CP_BUDGETCHANGEDETAILS_REJECT_CONFIRMATION", "CP_BUDGETCHANGEDETAILS_WITHDRAW_CONFIRMATION", "CP_BUDGETTRANSFERDETAILS_APPROVE_CONFIRMATION", "CP_BUDGETTRANSFERDETAILS_REJECT_CONFIRMATION", "CP_BUDGETTRANSFERDETAILS_WITHDRAW_CONFIRMATION", "BP_NOBUDGET_WARNING_CHANGE_STATE", "CP_BUDGET_APPROVED_MESSAGE_HEADER", "CP_BUDGET_APPROVED_MESSAGE", "CP_BUDGET_PROPOSED_MESSAGE_HEADER", "CP_BUDGET_PROPOSED_MESSAGE", "CP_REVIEW_NOTIFICATION", "CP_REVIEW_NOTIFICATION_DESC", "CP_APPROVAL_NOTIFICATION", "CP_APPROVAL_NOTIFICATION_DESC", "CP_SHARED_NOTIFICATION", "CP_SHARED_NOTIFICATION_DESC", "CP_LINK_ALL_COMPLETED", "CP_LINK_ALL_COMPLETED_DESC", "CP_LINK_ALL_FAILED", "CP_LINK_ALL_FAILED_DESC", "CP_SCENARIO_APPROVAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "CP_SCENARIO_APPROVAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "CP_SCENARIO_APPROVAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "CP_SCENARIO_APPROVAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "CP_SCENARIO_PROPOSAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "CP_SCENARIO_PROPOSAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "CP_SCENARIO_PROPOSAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "CP_SCENARIO_PROPOSAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "CP_SCENARIO_IN_PLANNING_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "CP_SCENARIO_IN_PLANNING_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "CP_SCENARIO_IN_PLANNING_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "CP_SCENARIO_IN_PLANNING_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "BP_OPTIMIZATION_BACKGROUND_JOB_IN_PROGRESS", "BP_OPTIMIZATION_SUCCESS_CONTEXT", "BP_OPTIMIZATION_FAILURE_CONTEXT", "BP_OPTIMIZATION_SUCCESS", "BP_OPTIMIZATION_FAILURE", "BP_SCENARIO_PROPOSE_BACKGROUND_JOB_IN_PROGRESS", "BP_SCENARIO_PROPOSE_BACKGROUND_JOB_IN_PROGRESS_RIBBON", "BP_SCENARIO_APPROVE_BACKGROUND_JOB_IN_PROGRESS_RIBBON", "RP_OPTIMIZATION_SUCCESS_CONTEXT", "RP_OPTIMIZATION_FAILURE_CONTEXT", "RP_OPTIMIZATION_SUCCESS", "RP_OPTIMIZATION_FAILURE", "CP_PROJECTCOSTING_INTRO", "CP_PROJECTCOSTING_FORECAST_COST_OVERWRITE", "CP_PROJECTCOSTING_COPY_PLANNEDBUDGETTOFORECAST", "CP_PROJECTCOSTING_COPY_ACTUALCOSTFROMP6TOACTUALS", "CP_PROJECTCOSTING_COPY_ATCOMPLETIONTOFORECAST", "CP_PROJECTCOSTING_WORKSPACE_INSUFFICIENT_VIEW_PRIVS", "CP_PROJECTCOSTING_WORKSPACE_NO_COST_HOURS_ALLOCATED", "CP_PROJECTCOSTING_INSUFFICIENT_VIEW_PRIVS", "CP_PROJECTCOSTING_NOT_UP_TO_DATE", "CP_PROJECTCOSTING_NOT_UP_TO_DATE_NO_EDIT", "CP_PROJECTCOSTING_COPY_PROPOSEDBUDGETTOPLANNED", "CP_PROJECTCOSTING_COPY_APPROVEDBUDGETTOPLANNED", "CP_INTEGRATION_SOURCE_NOT_SET", "CP_INTEGRATION_SUBCURVE_DATA_ROLLUP", "CP_INTEGRATION_SUMMARY_DATA_IGNORED", "CP_INTEGRATION_SUBCURVE_DATA_IGNORED", "CP_PROJECTSNAPSHOTCOMPARISON_INSUFFICIENT_PRIVS", "CP_SNAPSHOT", "STRATEGY_MEASURE_RECALCULATE_MEASURE_FOR_STRATEGIES_SUCCESFUL", "ANNOTATION_NOTIFY_DOCUMENT_OWNER_ON_ANNOTATION", "ANNOTATION_NOTIFY_DOCUMENT_OWNER_ON_ANNOTATION_WITH_COMMENT", "ANNOTATION_NOTIFY_DOCUMENT_OWNER_ON_DISCUSSION", "ANNOTATION_NOTIFY_DOCUMENT_OWNER_ON_DISCUSSION_WITH_COMMENT", "ANNOTATION_NOTIFY_DOCUMENT_ANNOTATOR_ON_DISCUSSION", "ANNOTATION_NOTIFY_DOCUMENT_ANNOTATOR_ON_DISCUSSION_WITH_COMMENT", "ANNOTATION_NOTIFY_OTHER_COMMENTER_ON_SAME_ANNOTATION", "ANNOTATION_NOTIFY_OTHER_COMMENTER_ON_SAME_ANNOTATION_WITH_COMMENT", "MANUAL_BUDGET_DEFAULT_SUBMIT_COMMENT", "MANUAL_BUDGET_DEFAULT_APPROVE_COMMENT", "MANUAL_BUDGET_DEFAULT_REJECT_COMMENT", "MANUAL_BUDGET_DEFAULT_WITHDRAW_COMMENT", "WORKFLOWS_EMAIL_MESSAGE", "WORKFLOWS_OVERDUE_EMAIL_INSTRUCTIONS", "WORKFLOWS_TASK_OVERDUE_EMAIL_INSTRUCTIONS", "WORKFLOWS_TASK_NOTIFICATION_POPUP_DESC", "WORKFLOWS_TASK_COMPLETED_DESC", "WORKFLOWS_MANUAL_DECISION_TASK_COMPLETED_DESC", "WORKFLOWS_UPDATE_FIELD_TASK_COMPLETED_DESC", "WORKFLOWS_REFRESH_TASK_COMPLETED_DESC", "WORKFLOWS_AUTOMATIC_DECISION_STEP_COMPLETED_DESC", "WORKFLOWS_SERVICES_TASK_COMPLETED_DESC", "WORKFLOWS_SERVICES_TASK_COMPLETED_DESC_COPY_WBS_SERVICE", "WORKFLOWS_SERVICES_TASK_COMPLETED_WITH_ERROR_DESC", "WORKFLOWS_UPDATE_FIELD_CODE_VALUES_DESC", "WORKFLOWS_OVERDUE_TASK_NOTIFICATION_POPUP_DESC", "WORKFLOWS_OVERDUE_NOTIFICATION_POPUP_DESC", "FORM_RESOURCE_ASSIGNMENT_COMPLETED_UI", "FORM_DOCUMENT_UPLOAD_ERROR_MESSAGE", "FORM_FOLDER_CREATION_ERROR_MESSAGE", "FORM_DOCUMENT_FOLDER_ERROR_MESSAGE", "DICTIONARY_ROC_PERCENT_COMPLETE_RANGE_ERROR", "SCOPE_VALIDATION_START_AFTER_FINISH_DATE", "SCOPE_VALIDATION_FINISH_BEFORE_START_DATE", "SCOPE_WPP_SCOPE_ITEM_OVER_ASSIGNED_UNITS", "SCOPE_WPP_NEGATIVE_NUMBER", "SCOPE_WPP_PROGRESS_INSTALLED_UNITS_GREATER_THAN_REVISED", "SCOPE_WPP_PROGRESS_AT_LEAST_ONE_INCREMENT_NOT_ZERO", "SCOPE_WPP_PROGRESS_INSTALLED_CANT_BE_ZERO", "SCOPE_PROJECT_BASELINE_COMPLETED", "SCOPE_PROJECT_BASELINE_COMPLETED_CONTEXT", "SCOPE_PROJECT_BASELINE_REVERT_COMPLETED", "SCOPE_WORK_PACKAGE_ASSIGNMENT_SPREADS_COMPLETED", "SCOPE_WORK_PACKAGE_CURVE_PROFILE_UPDATE_COMPLETED", "SCOPE_WORK_PACKAGE_CURVE_PROFILE_UPDATE_FAILED", "SCOPE_PROJECT_ASSIGNMENT_SPREADS_COMPLETED", "SCOPE_ITEM_CHANGE_DUPLICATE_QUANTITY", "SCOPE_ITEM_CHANGE_DUPLICATE_CBS", "SCOPE_WP_REFRESH_LINK", "SCOPE_ITEM_IMPORT_CELL_VALUE_SET_TO_NULL", "SCOPE_ITEM_IMPORT_UOM_NOT_FOUND", "CHANGE_REQUEST_LINK", "CHANGE_REQUEST_WITHDRAWN_APPROVAL_INBOX", "CHANGE_REQUEST_WITHDRAWN_APPROVAL_HEADER", "CHANGE_REQUEST_REOPENED_REJECTION_INBOX", "CHANGE_REQUEST_REOPENED_REJECTION_HEADER", "CHANGE_REQUEST_ITEM_REOPENED_REJECTION_INBOX", "CHANGE_REQUEST_ITEM_REOPENED_REJECTION_HEADER", "CHANGE_REQUEST_EMAIL_TITLE_WITHDRAW", "CHANGE_REQUEST_EMAIL_TITLE_REOPENED", "WORK_PACKAGE_ASSOCIATION_FOR_PARENT", "SCOPE_WBS_DELETE_WITH_ACTIVITIES_CONFIRM", "SCOPE_BASELINE_EARNED_VALUE_ADD_CONFIRM", "SCOPE_BASELINE_EARNED_VALUE_DELETE_CONFIRM", "SCOPE_BASELINE_IN_PROGRESS_INFO_BANNER", "COPY_WBS", "SYSTEM_ANNOUNCEMENTS_TITLE_REQUIRED", "SYSTEM_ANNOUNCEMENTS_DATE_REQUIRED", "SYSTEM_ANNOUNCEMENTS_TITLE_UNIQUE", "ADMIN_GLOBAL_SECURITY_DELETE_MESSAGE", "WORKFLOWS_STARTWORKFLOW_ALERT_CONTEXT_NOT_DEFINED_MESSAGE", "WORKFLOWS_STARTWORKFLOW_ALERT_HAS_VALIDATION_ERRORS_MESSAGE", "WORKFLOWS_UI_CONTEXT_STARTWORKFLOW_ALERT_CONTEXT_NOT_DEFINED", "WORKFLOWS_UI_CONTEXT_STARTWORKFLOW_ALERT_HAS_PRE_VALIDATION_ERRORS", "WORKFLOWS_UI_CONTEXT_STARTWORKFLOW_ALERT_HAS_VALIDATION_ERRORS", "WORKFLOWS_UI_CONTEXT_STARTWORKFLOW_ALERT_HAS_ERRORS", "FORMS_EDITOR_CONFIRM_CHANGE_FORM_CONTEXT_TYPE", "FORMS_EDITOR_CONFIRM_CHANGE_PICKER_BUSINESS_OBJECT", "FORMS_NEW_VERSION_CREATED", "FORMS_DRAFT_VERSION_CREATED", "FORMS_UNABLE_TO_LOAD", "FORM_SEED_FORM_MISSING_VALIDATION_TITLE", "SEED_FORM_MISSING_VALIDATION_DESCRIPTION", "FORM_VALIDATION_MISSING_MAPPED_FIELD_DESCRIPTION", "WORKFLOWS_VALIDATION_TYPE_WORKFLOW_MANAGER", "WORKFLOWS_VALIDATION_TYPE_TASK_PERFORMER", "WORKFLOWS_VALIDATION_TYPE_SUB_WORKFLOW_MANAGER", "WORKFLOWS_VALIDATION_TYPE_MISSING_STEP", "WORKFLOWS_VALIDATION_TYPE_DUPLICATE_STEP_NAME", "WORKFLOWS_VALIDATION_TYPE_MISSING_TASK", "WORKFLOWS_VALIDATION_TYPE_DUPLICATE_TASK_NAME", "WORKFLOWS_VALIDATION_TYPE_DUPLICATE_EXIT_OPTION_NAME", "WORKFLOWS_VALIDATION_TYPE_MISSING_CONNECTOR_LINE", "WORKFLOWS_VALIDATION_TYPE_ILLEGAL_CONNECTOR_LINE", "WORKFLOWS_VALIDATION_TYPE_CONTEXT_NOT_DEFINED", "WORKFLOWS_VALIDATION_TYPE_CONTEXT_TYPE_MISMATCH", "WORKFLOWS_VALIDATION_TYPE_FORM_TASK", "WORKFLOWS_VALIDATION_TYPE_AUTOMATIC_DECISION_TASK", "WORKFLOWS_VALIDATION_TYPE_MANUAL_DECISION_TASK", "WORKFLOWS_VALIDATION_TYPE_SUB_WORKFLOW_TASK", "WORKFLOWS_VALIDATION_TYPE_UPDATE_FIELD_TASK", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK", "WORKFLOWS_VALIDATION_TYPE_COPY_WBS_SERVICES_TASK", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_BUSINESS_FLOW_NULL", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_INTEGRATION_NULL", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_REPORT_ID_NULL_OR_INACTIVE", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_REPORT_INACTIVE_OR_DELETED", "WORKFLOWS_VALIDATION_TYPE_SERVICES_TASK_REPORT_EMAIL_TO_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_TYPE_SCENARIO_NOT_DEFINED", "WORKFLOWS_VALIDATION_TYPE_CONTEXT_FIELD_MISMATCH", "WORKFLOWS_VALIDATION_TYPE_TASK_DISTRIBUTION", "WORKFLOWS_VALIDATION_TYPE_DURATION", "WORKFLOWS_VALIDATION_EXCEEDED_PORTFOLIO_MAX_LIMIT", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_NOT_IN_LDAP", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_ROLE_PRIMARY_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_NOT_IN_LDAP", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_ROLE_AND_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_ROLE_AND_CONTEXT_NEW_PROJECT", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_ROLE_AND_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_NOT_IN_LDAP", "WORKFLOWS_VALIDATION_DESCRIPTION_INVALID_MANAGER_USER_GROUP", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_ROLE_AND_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_ROLE_AND_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_WITH_NO_STEP", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_WITH_DUPLICATE_STEP_NAME", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_STEP_HAS_NO_TASKS", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_STEP_WITH_DUPLICATE_TASK_NAME", "WORKFLOWS_VALIDATION_DESCRIPTION_WORKFLOW_WITH_DUPLICATE_EXIT_OPTION_NAME", "WORKFLOWS_VALIDATION_DESCRIPTION_STEP_NOT_CONNECTED_AT_EXIT", "WORKFLOWS_VALIDATION_DESCRIPTION_STEP_NOT_CONNECTED_AT_ENTRY_POINT", "WORKFLOWS_VALIDATION_DESCRIPTION_DECISION_STEP_HAS_ONLY_ONE_EXIT", "WORKFLOWS_VALIDATION_DESCRIPTION_START_STEP_CONNECTED_AT_ENTRY_POINT", "WORKFLOWS_VALIDATION_DESCRIPTION_FINAL_STEP_UNREACHABLE", "WORKFLOWS_VALIDATION_DESCRIPTION_START_STEP_NOT_CONNECTED", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_STEP_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_STEP_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_CONTEXT_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_CONTEXT_SAME_AS_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_CONTEXT_SAME_AS_SUB_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_FORM_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_PERFORMER_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_MANAGER_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_CONTEXT_MISMATCH", "WORKFLOWS_VALIDATION_DESCRIPTION_FORM_FIELD_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_FORM_NEW", "WORKFLOWS_VALIDATION_DESCRIPTION_FORM_DISABLED", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_FIELD_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_NO_VALUE_DEFINED_FOR_OPTION", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_VALUE_LEADS_TO_MORE_THAN_ONE_OPTION", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_CONDITIONS_NOT_FULLY_DEFINED", "WORKFLOWS_VALIDATION_DESCRIPTION_MANUAL_DECISION_MISSING_QUESTION", "WORKFLOWS_VALIDATION_DESCRIPTION_MANUAL_DECISION_MISSING_NAME", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_SUB_WORKFLOW_DISABLED", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_NULL", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_VALUE_NOT_DEFINED", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_DATE_FIELD_VALUE_NOT_DEFINED", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_DATE_LOOKUP_FIELD_VALUE_NOT_DEFINED", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_SCENARIO_AND_CONTEXT_CP", "WORKFLOWS_VALIDATION_DESCRIPTION_UPDATE_FIELD_SCENARIO_AND_CONTEXT_SAME_AS_WORKFLOW_CP", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_FIELD_SCENARIO_AND_CONTEXT_CP", "WORKFLOWS_VALIDATION_DESCRIPTION_AUTOMATIC_DECISION_FIELD_SCENARIO_AND_CONTEXT_SANE_AS_WORKFLOW_CP", "WORKFLOWS_VALIDATION_DESCRIPTION_TASK_CONTEXT_SAME_AS_WORKFLOW_CP_AND_DISTRIBUTION_SCENARIOS", "WORKFLOWS_VALIDATION_DESCRIPTION_FIRST_STEP_NOT_PREASSIGNED", "WORKFLOWS_VALIDATION_DESCRIPTION_STEP_FROM_AUTMATIC_DECISION_NOT_PREASSIGNED", "WORKFLOWS_VALIDATION_DESCRIPTION_EXCEEDED_PORTFOLIO_MAX_LIMIT", "WORKFLOWS_OVERRIDE_TASK", "WORKFLOWS_TASK_OVERRIDE", "WORKFLOWS_VALIDATION_DESCRIPTION_INVALID_NEWPROJECTFORM", "WORKFLOWS_VALIDATION_SERVICE_TASK_TYPE_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_CONF_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_INTEGRATION_TYPE_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_P6_EPPM_CONFIGURATION_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_P6_EPPM_BUSINESS_FLOW_ID_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_PRIMAVERA_GATEWAY_INTEGRATION_ID_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_SYNCHRONIZATION_INTEGRATION_TYPE_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_RECALCULATE_COST_CONF_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_RECALCULATE_COST_SCENARIO_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_REPORT_CONF_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_REPORT_ID_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_REPORT_INACTIVE_OR_DELETED", "WORKFLOWS_VALIDATION_SERVICE_TASK_REPORT_CONFIGURED_EMAIL_TO_USERS_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_COPY_WBS_CONF_NULL_OR_INVALID", "WORKFLOWS_VALIDATION_SERVICE_TASK_SOURCE_WBS_ID_NULL", "WORKFLOWS_VALIDATION_SERVICE_TASK_TARGET_WBS_ID_NULL", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_WORKFLOW_MANAGER", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_CONTEXT_FIELD_MISMATCH", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_TASK_DISTRIBUTION", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_SUB_WORKFLOW_TASK", "WORKFLOWS_PRE_EXECUTION_VALIDATION_TYPE_FORM_TASK", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_NOT_IN_LDAP", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_NO_MANAGER_ERROR", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_WORKFLOW_MANAGER_NOT_VALID_WITHOUT_CONTEXT", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_UPDATE_FIELD_CONTEXT_CP_AND_UPDATE_FIELD_SCENARIO", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_AUTOMATIC_CONDITION_CONTEXT_CP_AND_CONDITION_FIELD_SCENARIO", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_TASK_CONTEXT_SCENARIO_AND_DISTRIBUTION_SCENARIOS", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_SUB_WORKFLOW_DISABLED", "WORKFLOWS_PRE_EXECUTION_VALIDATION_DESCRIPTION_FORM_DISABLED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_STARTED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_STOPPED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_COMPLETED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_CONTEXT_DEFINED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_ARCHIVED", "WORKFLOWS_REPORT_EVENT_TYPE_WORKFLOW_ABORTED", "WORKFLOWS_REPORT_EVENT_TYPE_STEP_STARTED", "WORKFLOWS_REPORT_EVENT_TYPE_AUTOMATIC_DECISION_STEP_EXECUTED", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_INSTANTIATED", "WORKFLOWS_REPORT_EVENT_TYPE_NO_TASKS_INSTANTIATED", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_REASSIGNED", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_COMPLETED", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_COMPLETED_BY_MANAGER", "WORKFLOWS_REPORT_EVENT_TYPE_TASK_EXECUTED", "WORKFLOW_INSTANCE_STATUS_EXECUTING", "WORKFLOW_INSTANCE_STATUS_STOPPED", "WORKFLOW_INSTANCE_STATUS_HALTED", "WORKFLOW_INSTANCE_STATUS_PENDING", "WORKFLOW_INSTANCE_STATUS_FINISHED", "WORKFLOWS_REPORT_WORKFLOW", "WORKFLOWS_REPORT_CONTEXT_B", "WORKFLOWS_REPORT_CONTEXT_STEP", "WORKFLOWS_REPORT_CONTEXT_TASK", "WORKFLOWS_REPORT_CONTEXT_NULL", "WORKFLOWS_REPORT_CONTEXT_CAPITAL_PLAN", "WORKFLOWS_REPORT_CONTEXT_CAPITAL_PLAN_SCENARIO", "WORKFLOWS_REPORT_CONTEXT_CAPITAL_PLAN_PROJECT", "WORKFLOWS_REPORT_CONTEXT_CAPITAL_PLAN_SCENARIO_PROJECT", "WORKFLOWS_REPORT_CONTEXT_PROJECT", "WORKFLOWS_REPORT_CONTEXT_NEW_PROJECT", "WORKFLOWS_REPORT_CONTEXT_CONTRACT", "WORKFLOWS_REPORT_CONTEXT_COMMITMENT", "WORKFLOWS_REPORT_CONTEXT_BUDGET", "WORKFLOWS_REPORT_CONTEXT_NOT_DEFINED", "WORKFLOWS_REPORT_MANAGER", "WORKFLOWS_REPORT_STARTED_BY", "WORKFLOWS_REPORT_STOPPED_IN_STEP", "WORKFLOWS_REPORT_SUB_WORKFLOW", "WORKFLOWS_REPORT_BY", "WORKFLOWS_REPORT_NEW_CONTEXT", "WORKFLOWS_REPORT_STEP", "WORKFLOWS_REPORT_TASK", "WORKFLOWS_REPORT_ARCHIVED_BY", "WORKFLOWS_REPORT_DECISION_OPTION_SELECTED", "WORKFLOWS_REPORT_FORM", "WORKFLOWS_REPORT_PERFORMER", "WORKFLOWS_REPORT_NEW_PERFORMER", "WORKFLOWS_REPORT_PERFORMER_INITIATOR", "WORKFLOWS_REPORT_MANUAL_DECISION", "WORKFLOWS_REPORT_NONE", "WORKFLOWS_REPORT_DECISION_TYPE", "WORKFLOWS_REPORT_DECISION_TASKS_SENT", "WORKFLOWS_REPORT_UPDATED_BY_SYSTEM", "WORKFLOWS_REPORT_UPDATE_FIELD", "WORKFLOWS_REPORT_SUB_WORKFLOW_B", "WORKFLOWS_REPORT_SYNCHRONOUS", "WORKFLOWS_REPORT_ASYNCHRONOUS", "WORKFLOWS_REPORT_SUB_WORKFLOW_MANAGER", "WORKFLOWS_REPORT_SUB_WORKFLOW_MANAGER_INITIATOR", "WORKFLOWS_REPORT_WORKFLOW_ABORTED_DUE_TO_ERROR", "WORKFLOWS_REPORT_SYNCHRONOUS_SUB_WORKFLOW_STOPPED", "WORKFLOWS_REPORT_SYNCHRONOUS_SUB_WORKFLOW_FAULTED", "WORKFLOWS_REPORT_IN", "WORKFLOWS_REPORT_FAILED_IN", "WORKFLOWS_REPORT_TASK_B", "WORKFLOWS_REPORT_FORM_B", "WORKFLOWS_REPORT_MANUAL_DECISION_B", "WORKFLOWS_REPORT_UPDATE_FIELD_B", "WORKFLOWS_REPORT_PORTFOLIO_REFRESH_B", "WORKFLOW_REPORT_SERVICES_B", "WORKFLOWS_REPORT_SUB_WORKFLOW_C", "WORKFLOWS_REPORT_COMPLETED_BY_MANAGER", "WORKFLOWS_REPORT_ERROR", "WORKFLOWS_REPORT_REASON", "WORKFLOWS_REPORT_WARNING", "WORKFLOWS_REPORT_AUTOMATIC_DECISION", "WORKFLOWS_REPORT_ERROR_IN_SUB_WORKFLOW", "WORKFLOWS_REPORT_SUB_WORKFLOW_DISABLED", "WORKFLOWS_REPORT_SUB_WORKFLOW_CONTAINS_VALIDATION_ERRORS", "WORKFLOWS_REPORT_SUB_WORKFLOW_CONTAINS_PRE_EXECUTION_VALIDATION_ERRORS", "WORKFLOWS_REPORT_SUB_WORKFLOW_RECURSION_LIMIT_EXCEEDED", "WORKFLOWS_REPORT_CONTEXT_TYPE_OF_START_SUB_WORKFLOW_DIFFERS", "WORKFLOWS_REPORT_ERROR_IN_FORM", "WORKFLOWS_REPORT_FORM_DISABLED", "WORKFLOWS_REPORT_CONTEXT_TYPE_OF_FORM_DIFFERS", "WORKFLOWS_REPORT_PROJECT", "WORKFLOWS_REPORT_FORM_DOES_NOT_SUPPORT_CREATION_OF_A_NEW", "WORKFLOWS_REPORT_MANAGER_OF_SUB_WORKFLOW_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PERFORMER_OF_FORM_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PERFORMER_OF_MANUAL_DECISION_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PERFORMER_OF_UPDATE_FIELD_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PERFORMER_OF_SERVICES_TASK_DOES_NOT_EXIST_IN_THE_SYSTEM", "WORKFLOWS_REPORT_PROJECT_CODE_NOT_RESOLVED", "WORKFLOWS_REPORT_UPDATE_VALUE_CODE_NOT_RESOLVED", "WORKFLOWS_REPORT_UPDATE_VALUE_CODE_NOT_FOUND", "WORKFLOWS_REPORT_UPDATE_USER_FIELD_NOT_FOUND", "WORKFLOWS_REPORT_PORTFOLIO_NOT_FOUND", "WORKFLOWS_REPORT_UPDATE_VALUE_LIST_UDF_NOT_FOUND", "WORKFLOWS_REPORT_UPDATE_VALUE_UDF_DISABLED", "WORKFLOWS_REPORT_NO_TASKS_GENERATED_FOR_STEP", "WORKFLOWS_REPORT_SYSTEM_UPDATED_ON_BEHALF", "WORKFLOWS_REPORT_RFI", "WORKFLOWS_REPORT_IDEA", "WORKFLOWS_REPORT_PROGRAM", "MONITOR_WORKFLOW_EVENT_NAME_WITH_PREFIX", "MONITOR_WORKFLOW_EVENT_NOT_AVAILABLE", "ERRONEOUS_WORKFLOW_PROPOSE_RISK_ERROR_TITLE", "DOCUMENT_DELETE_CONFIRMATION", "DOCUMENT_UNLINK_CONFIRMATION", "DOCUMENTS_EXTENSION_ERROR", "DOCUMENT_ADD_SECURITY_MESSAGE", "DOCUMENT_LINK_SECURITY_MESSAGE", "DOCUMENTS_TEMPLATE_COPY_NOTIFICATION_SHORT", "DOCUMENTS_TEMPLATE_COPY_NOTIFICATION", "DOCUMENTS_TEMPLATE_COPY_ERROR_SHORT", "DOCUMENTS_TEMPLATE_COPY_ERROR", "PROJECT_DOCUMENTS_COPY_NOTIFICATION", "PROJECT_DOCUMENTS_COPY_ERROR", "DOCUMENTS_VIRUSSCAN_FAILED_NOTIFICATION_SHORT", "DOCUMENTS_VIRUSSCAN_FAILED_NOTIFICATION", "DOCUMENTS_VIRUSSCAN_INCONCLUSIVE_NOTIFICATION_SHORT", "DOCUMENTS_VIRUSSCAN_INCONCLUSIVE_NOTIFICATION", "DOCUMENTS_VIRUSSCAN_ERROR_NOTIFICATION_SHORT", "DOCUMENTS_VIRUSSCAN_ERROR_NOTIFICATION", "DOCUMENTS_VIRUSSCAN_SUCCESS_NOTIFICATION_SHORT", "DOCUMENTS_VIRUSSCAN_SUCCESS_NOTIFICATION", "DOCUMENTS_VIRUSSCAN_STATUS_PENDING", "DOCUMENTS_VIRUSSCAN_STATUS_CLEARED", "DOCUMENTS_VIRUSSCAN_STATUS_FAILED", "DOCUMENTS_VIRUSSCAN_STATUS_INCONCLUSIVE", "DOCUMENTS_VIRUSSCAN_STATUS_ERROR", "REPORT_NOTIFY_INACTIVE_REPORT_NOT_RUN_LONG", "REPORT_NOTIFY_READY_TO_VIEW", "REPORT_NOTIFY_CANNOT_GENERATE_REPORT", "REPORT_ERROR_UNABLE_TO_LOAD_LAYOUTS", "REPORT_DATA_EXCEED_LIMIT_EMAIL_INSTRUCTIONS", "REPORT_ACCESSIBILITY_CONTEXT", "SINGLE_RECORD_PRINT_TIMEOUT_REPORT_RUNNING_IN_BACKGROUND", "SINGLE_RECORD_PRINT_REPORT_RUNNING_IN_BACKGROUND", "SINGLE_RECORD_PRINT_NOTIFY_READY_TO_VIEW", "SERVICE_PROFILEMIGRATION_GLOBAL_STAGE", "SERVICE_PROFILEMGIRATION_GLOBAL_START", "SERVICE_PROFILEMIGRATION_USERS_NOTFOUND", "SERVICE_PROFILEMIGRATION_USERS_FOUND", "SERVICE_PROFILEMIGRATION_GLOBAL_SUPERUSER", "SERVICE_PROFILEMIGRATION_GLOBAL_SUCCESS_NOUSERS", "SERVICE_PROFILEMIGRATION_SUCCESS", "SERVICE_PROFILEMIGRATION_COMPLETE", "SERVICE_PROFILEMIGRATION_PROJECT_STAGE", "SERVICE_PROFILEMGIRATION_PROJECT_START", "SERVICE_PROFILEMGIRATION_PROJECT_NOPROJECT", "SERVICE_PROFILEMGIRATION_PROJECT_NOUSERS", "SERVICE_PROFILEMGIRATION_PROJECT_FOUND", "SERVICE_PROFILEMIGRATION_PROJECT_GROUP", "CBS_CONFIRM_DIALOG_WS_SAVE", "CBS_DETAILS_SAVE_ALERT", "CBS_IMPORT_NO_CODES_TO_IMPORT", "CBS_RECALCULATE_COST_FAILED_CONTEXT", "CBS_RECALCULATE_COST_SUCCESS", "CBS_RECALCULATE_COST_SUCCESS_CONTEXT", "CBS_RECALCULATE_COST_WORKSPACE_FAILED_CONTEXT", "CBS_RECALCULATE_COST_WORKSPACE_SUCCESS", "CBS_RECALCULATE_COST_WORKSPACE_SUCCESS_CONTEXT", "CBS_RECALCULATE_COST_PROGRAM_SUCCESS", "CBS_RECALCULATE_COST_PROGRAM_SUCCESS_CONTEXT", "PROGRAM_CALCULATE_PROGRAM_PROJECT_CURVES_COSTS_FAILED_CONTEXT", "PROGRAM_CALCULATE_PROGRAM_PROJECT_CURVES_COSTS_SUCCESS", "PROGRAM_CALCULATE_PROGRAM_PROJECT_CURVES_COSTS_SUCCESS_CONTEXT", "CBS_RECALCULATE_COST_VIEW_SHEET", "PROGRAM_CALCULATE_COST_CURVE_VIEW", "ROLES_REFRESH_LINK", "PROJECT_BUDGET_NO_CBS_CODES_WITH_CREATE_PRIVILEGE", "PROJECT_BUDGET_LINK", "PROJECT_BUDGET_SUBMIT_DIALOG_COMMENT", "PROJECT_BUDGET_SUBMIT_DIALOG_INBOX", "PROJECT_BUDGET_SUBMIT_DIALOG_HEADER", "PROJECT_BUDGET_REJECT_DIALOG_COMMENT", "PROJECT_BUDGET_REJECT_DIALOG_INBOX", "PROJECT_BUDGET_REJECT_DIALOG_HEADER", "PROJECT_BUDGET_APPROVAL_DIALOG_COMMENT", "PROJECT_BUDGET_APPROVAL_DIALOG_INBOX", "PROJECT_BUDGET_APPROVAL_DIALOG_HEADER", "PROJECT_BUDGET_WITHDRAW_APPROVAL_DIALOG_COMMENT", "PROJECT_BUDGET_WITHDRAW_APPROVAL_DIALOG_INBOX", "PROJECT_BUDGET_WITHDRAW_APPROVAL_DIALOG_HEADER", "PROJECT_BUDGET_EXCEL_NOTIFICATION_REFRESH_LINK", "BUDGET_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "BUDGET_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "BUDGET_STATUS_CHANGE_EMAIL_TITLE_REJECT", "BUDGET_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "BUDGET_CHANGE_LINK", "BUDGET_CHANGE_SUBMIT_DIALOG_COMMENT", "BUDGET_CHANGE_SUBMIT_DIALOG_INBOX", "BUDGET_CHANGE_SUBMIT_DIALOG_HEADER", "BUDGET_CHANGE_REJECT_DIALOG_COMMENT", "BUDGET_CHANGE_REJECT_DIALOG_INBOX", "BUDGET_CHANGE_REJECT_DIALOG_HEADER", "BUDGET_CHANGE_APPROVAL_DIALOG_COMMENT", "BUDGET_CHANGE_APPROVAL_DIALOG_INBOX", "BUDGET_CHANGE_APPROVAL_DIALOG_HEADER", "BUDGET_CHANGE_WITHDRAW_APPROVAL_DIALOG_COMMENT", "BUDGET_CHANGE_WITHDRAW_APPROVAL_DIALOG_INBOX", "BUDGET_CHANGE_WITHDRAW_APPROVAL_DIALOG_HEADER", "BUDGET_CHANGE_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "BUDGET_CHANGE_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "BUDGET_CHANGE_STATUS_CHANGE_EMAIL_TITLE_REJECT", "BUDGET_CHANGE_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "BUDGET_TRANSFER_LINK", "BUDGET_TRANSFER_SUBMIT_DIALOG_COMMENT", "BUDGET_TRANSFER_SUBMIT_DIALOG_INBOX", "BUDGET_TRANSFER_SUBMIT_DIALOG_HEADER", "BUDGET_TRANSFER_REJECT_DIALOG_COMMENT", "BUDGET_TRANSFER_REJECT_DIALOG_INBOX", "BUDGET_TRANSFER_REJECT_DIALOG_HEADER", "BUDGET_TRANSFER_APPROVAL_DIALOG_COMMENT", "BUDGET_TRANSFER_APPROVAL_DIALOG_INBOX", "BUDGET_TRANSFER_APPROVAL_DIALOG_HEADER", "BUDGET_TRANSFER_WITHDRAW_APPROVAL_DIALOG_COMMENT", "BUDGET_TRANSFER_WITHDRAW_APPROVAL_DIALOG_INBOX", "BUDGET_TRANSFER_WITHDRAW_APPROVAL_DIALOG_HEADER", "BUDGET_TRANSFER_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "BUDGET_TRANSFER_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "BUDGET_TRANSFER_STATUS_CHANGE_EMAIL_TITLE_REJECT", "BUDGET_TRANSFER_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "BUDGET_SUBMIT_DIALOG_COMMENT", "BUDGET_SUBMIT_DIALOG_INBOX", "BUDGET_SUBMIT_DIALOG_HEADER", "BUDGET_REJECT_DIALOG_COMMENT", "BUDGET_REJECT_DIALOG_INBOX", "BUDGET_REJECT_DIALOG_HEADER", "BUDGET_APPROVAL_DIALOG_COMMENT", "BUDGET_APPROVAL_DIALOG_INBOX", "BUDGET_APPROVAL_DIALOG_HEADER", "BUDGET_WITHDRAW_APPROVAL_DIALOG_COMMENT", "BUDGET_WITHDRAW_APPROVAL_DIALOG_INBOX", "BUDGET_WITHDRAW_APPROVAL_DIALOG_HEADER", "BUDGET_EXCEL_NOTIFICATION_REFRESH_LINK", "PROGRAM_BUDGET_LINK", "PRIMARY_PROGRAM_HELP_TEXT", "SCENARIO_VIEW_LINK", "PROJECT_ACTUALS_TOTAL_MUST_NOT_BE_ZERO", "PROJECT_ACTUALS_WITHDRAW_CONFIRMATION", "PROJECT_ACTUALS_REFRESH_LINK", "PROJECT_ACTUALS_INVALIDEXCHANGERATE", "PROJECT_CASCADE_DELETE_NOTIFY_SUCCESSFUL", "PROJECT_CASCADE_DELETE_NOTIFY_SUCCESSFUL_DESCRIPTION", "PROJECT_CASCADE_DELETE_NOTIFY_INCOMPLETE", "PROJECT_CASCADE_DELETE_NOTIFY_INCOMPLETE_DESCRIPTION", "PROJECT_CASCADE_DELETE_NOTIFY_FAILED", "PROJECT_CASCADE_DELETE_NOTIFY_FAILED_DESCRIPTION", "SCHEDULER_FAILED_PROJECT_ERROR_CONTEXT", "SCHEDULER_FAILED_PROJECT_SCENARIO_ERROR_CONTEXT", "SCHEDULER_FAILED_PROGRAM_ERROR_CONTEXT", "SCHEDULER_FAILED_MULTIPLE_PROJECTS_ERROR_CONTEXT", "SCHEDULER_FAILED_PORTFOLIO_ERROR_CONTEXT", "SCHEDULER_PROJECT_SUCCESS", "SCHEDULER_PROJECT_SCENARIO_SUCCESS", "SCHEDULER_PORTFOLIO_SUCCESS", "SCHEDULER_PROGRAM_SUCCESS", "SCHEDULER_PROJECT_SUCCESS_CONTEXT", "SCHEDULER_PROJECT_SCENARIO_SUCCESS_CONTEXT", "SCHEDULER_PORTFOLIO_SUCCESS_CONTEXT", "SCHEDULER_PROGRAM_SUCCESS_CONTEXT", "SCHEDULER_MULTIPLE_PROJECTS_SUCCESS_CONTEXT", "SCHEDULER_LOG_AUTO_RECALCULATE_COST_IN_PROGRAM", "SCHEDULER_LOG_AUTO_RECALCULATE_COST_WITHOUT_PRIVILEGE", "FUNCTION_FULL_RECALC_CYCLE_COMPLETED", "FUNCTION_FULL_RECALC_CYCLE_COMPLETED_DESC", "FUNCTION_FULL_RECALC_CYCLE_FAILED", "FUNCTION_FULL_RECALC_CYCLE_FAILED_DESC", "FUNCTION_FULL_RECALC_CYCLE_STARTED", "FUNCTION_FULL_RECALC_CYCLE_STARTED_DESC", "FUNCTION_AUTO_RECALC_FOR_BASELINE_ACTION", "FUNCTION_AUTO_RECALC_FOR_BASELINE_ACTION_DESC", "FUNCTION_RECALC_POST_IMPORT_JOB_COMPLETED", "FUNCTION_RECALC_POST_IMPORT_JOB_COMPLETED_DESC", "FUNCTION_RECALC_POST_IMPORT_JOB_COMPLETED_WITH_ERRORS", "FUNCTION_RECALC_POST_IMPORT_JOB_COMPLETED_WITH_ERRORS_DESC", "FUNCTION_RECALC_POST_IMPORT_JOB_FAILED", "FUNCTION_RECALC_POST_IMPORT_JOB_FAILED_DESC", "RECALCULATE_SCHEDULE_COST_FAILED_PROJECT_ERROR_CONTEXT", "RECALCULATE_SCHEDULE_COST_FAILED_PROJECT_SCENARIO_ERROR_CONTEXT", "RECALCULATE_SCHEDULE_COST_FAILED_PORTFOLIO_ERROR_CONTEXT", "RECALCULATE_SCHEDULE_COST_FAILED_PROGRAM_ERROR_CONTEXT", "RECALCULATE_SCHEDULE_COST_PROJECT_SUCCESS", "RECALCULATE_SCHEDULE_COST_PROJECT_SCENARIO_SUCCESS", "RECALCULATE_SCHEDULE_COST_PORTFOLIO_SUCCESS", "RECALCULATE_SCHEDULE_COST_PROGRAM_SUCCESS", "RECALCULATE_SCHEDULE_COST_FAILED_SECURITY_LOG_DETAILS", "CBS_SYNC_SUCCESS", "CBS_SYNC_VIEW_LINK", "CBS_SYNC_FAILED_PROJECT_ERROR_CONTEXT", "CBS_SYNC_FAILED_CONTEXT", "CBS_SYNC_SUCCESS_LOG", "CALCULATE_PROJECT_SPREADS_SUCCESS", "CALCULATE_PROJECT_SPREADS_SUCCESS_CONTEXT", "CALCULATE_PROJECT_SPREADS_FAILED_ERROR_CONTEXT", "CALCULATE_SPREADS_FAILED_ERROR_PREFIX", "CALCULATE_SPREADS_REQUEST_SETTINGS_ERROR", "CALCULATE_ASSIGNMENT_SPREADS_REQUEST_DETAILS_HEADER_SUCCESS", "CALCULATE_ASSIGNMENT_SPREADS_REQUEST_DETAILS_HEADER_FAILED", "CALCULATE_ASSIGNMENT_SPREADS_REQUEST_DETAILS_HEADER_WARNING", "CALCULATE_SPREADS_COST_ITEMS_IGNORED_WARNING", "LEVELER_FAILED_PROJECT_ERROR_CONTEXT", "LEVELER_FAILED_PROJECT_SCENARIO_ERROR_CONTEXT", "LEVELER_UNABLE_TO_RUN_ERROR_CONTEXT", "LEVELER_SUCCESS", "LEVELER_SCENARIO_SUCCESS", "LEVELER_SUCCESS_CONTEXT", "LEVELER_SCENARIO_SUCCESS_CONTEXT", "VIEW_ACTIVITIES_LINK", "RUN_GLOBAL_CHANGE_PROJECT_SUCCESS", "RUN_GLOBAL_CHANGE_PROJECT_SUCCESS_SCENARIO", "RUN_GLOBAL_CHANGE_PROJECT_SUMMARY", "RUN_GLOBAL_CHANGE_PROJECT_SUMMARY_SCENARIO", "RUN_GLOBAL_CHANGE_PROJECT_SUMMARY_FAILED_NO_RECORD", "RUN_GLOBAL_CHANGE_PROJECT_FAILED", "RUN_GLOBAL_CHANGE_PROJECT_FAILED_SCENARIO", "RUN_GLOBAL_CHANGE_PROJECT_FAILED_NO_RECORD", "GET_GLOBAL_CHANGE_FAILED_COPY", "STORE_PERIOD_PROJECT_SUCCESS_CONTEXT", "STORE_PERIOD_PROJECT_SUCCESS", "STORE_PERIOD_NO_LAST_PERIOD", "STORE_PERIOD_PROJECT_FAILED", "RUN_STORE_PERIOD_PROJECT_SUMMARY", "STORE_PERIOD_FAILED_NO_RECORD", "STORE_PERIOD_SECURITY_FAILURE_LOG", "APPLY_ACT_UNCERTAINTY_FAILED_PROJECT_ERROR_CONTEXT", "APPLY_ACT_UNCERTAINTY_FAILED_PORTFOLIO_ERROR_CONTEXT", "APPLY_ACT_UNCERTAINTY_PROJECT_SUCCESS", "APPLY_ACT_UNCERTAINTY_PORTFOLIO_SUCCESS", "APPLY_ACT_UNCERTAINTY_PROJECT_SCENARIO_SUCCESS", "APPLY_ACT_UNCERTAINTY_FAILED_PROJECT_SCENARIO_ERROR_CONTEXT", "APPLY_ACT_UNCERTAINTY_PROGRAM_SUCCESS", "APPLY_ACT_UNCERTAINTY_FAILED_PROGRAM_ERROR_CONTEXT", "RISK_ANALYSIS_UNABLE_TO_RUN_ERROR_CONTEXT", "RISK_ANALYSIS_NO_POST_DATA_ERROR_CONTEXT", "RISK_ANALYSIS_FAILED_ERROR_CONTEXT", "RISK_ANALYSIS_COMPLETED_PRE", "RISK_ANALYSIS_COMPLETED_PRE_CONTEXT", "RISK_ANALYSIS_COMPLETED_POST", "RISK_ANALYSIS_COMPLETED_POST_CONTEXT", "RISK_ANALYSIS_COMPLETED_SENSITIVITY", "RISK_ANALYSIS_COMPLETED_SENSITIVITY_CONTEXT", "RISK_ANALYSIS_COMPLETED", "RISK_ANALYSIS_COMPLETED_CONTEXT", "RISK_REGISTER_NO_VIEW_PRIVILEGES", "RISK_MATRIX_JOB_TRIGGERED", "RISK_ANALYSIS_SCATTER_PLOT_CONFIRM_SAVE_TARGET", "RISK_ANALYSIS_SCATTER_PLOT_NOT_AVAILABLE", "RISK_QUANTIFIED_IMPACT_CALCULATION_FAILED", "RISK_QUANTIFIED_IMPACT_CALCULATION_FAILED_CONTEXT", "RISK_QUANTIFIED_IMPACT_CALCULATION_SUCCESSFUL", "RISK_QUANTIFIED_IMPACT_CALCULATION_SUCCESSFUL_CONTEXT", "MC_WEATHER_RUN_IN_PROGRESS", "MC_WEATHER_RUN_FAILED", "MC_WEATHER_RUN_COMPLETED", "MC_WEATHER_RUN_IN_PROGRESS_CONTEXT", "MC_WEATHER_RUN_FAILED_CONTEXT", "MC_WEATHER_RUN_COMPLETED_CONTEXT", "RISK_SCORING_MATRICES_THRESHOLD_CHANGE_WITH_RISKS", "RISK_SCORING_MATRICES_USER_CHANGED", "RISK_SCORING_MATRICES_CHANGE_SCORE_METHOD", "RISK_REGISTER_ASSIGN_MATRIX_SUCCESSFUL", "RISK_REGISTER_ASSIGN_MATRIX_FAILED", "RISK_REGISTER_REMOVE_MATRIX", "RISK_EXCEL_NOTIFICATION_REFRESH_LINK", "GATEWAY_NOTIFICATION_SHORT_DESC_STARTED", "GATEWAY_NOTIFICATION_SHORT_DESC_COMPLETED", "GATEWAY_NOTIFICATION_SHORT_DESC_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_SHORT_DESC_FAILED", "GATEWAY_NOTIFICATION_SHORT_DESC_IMPORT_COMPLETED", "GATEWAY_NOTIFICATION_SHORT_DESC_IMPORT_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_SHORT_DESC_IMPORT_FAILED", "GATEWAY_NOTIFICATION_MESSAGE_SYNCHRONIZATION_STARTED", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_COMPLETED", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_FAILED", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_COMPLETED", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_FAILED", "GATEWAY_NOTIFICATION_MESSAGE_MASTER_DATA_STARTED", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_MASTER_DATA_COMPLETED", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_MASTER_DATA_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_MESSAGE_EXPORT_MASTER_DATA_FAILED", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_MASTER_DATA_COMPLETED", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_MASTER_DATA_COMPLETED_WITH_ERRORS", "GATEWAY_NOTIFICATION_MESSAGE_IMPORT_MASTER_DATA_FAILED", "CHARTS_EMPTY_STATE_MESSAGE", "CHARTS_EMPTY_STATE_MESSAGE_VIEW_ONLY", "SM_CONFIRM_CONVERT_TO_SUMMARY_ACTIVITY", "SM_CONFIRM_CONVERT_TO_WBS_SUMMARY_ACTIVITY", "SM_CONFIRM_CHANGE_ACTIVITY_STATUS_TO_TK_NOTSTART_VALIDATION", "SM_PRE_RESPONSE_NAME_STRING", "SM_POST_RESPONSE_NAME_STRING", "SM_RECALCULATE_SCHEDULE_HEALTH_VIEW", "SM_RECALCULATE_SCHEDULE_HEALTH_FAILED_CONTEXT", "SM_RECALCULATE_SCHEDULE_HEALTH_SUCCESS", "SM_RECALCULATE_SCHEDULE_HEALTH_SUCCESS_CONTEXT", "SM_SCHEDULE_WAIT_CURRENT", "SM_SCHEDULE_WAIT_CURRENT_PROCESS", "SM_BASELINE_SET_CURRENT_SCHEDULE", "SM_REMOVE_ALL_LABOR_NONLABOR_COSTS", "SM_REMOVE_ALL_LABOR_NONLABOR_COSTS_PLURAL", "SM_CONFIRM_ACTIVITY_DELETE", "SM_PERIOD_PERFORMANCE_CHANGE_TO_NOT_STARTED_WITH_SPP_DATA", "SM_COPY_ACTIVITY_FILE_FAILED", "SM_COPY_ACTIVITY_FILE_FAILED_WITH_FILE_MICROSERVICE_DOWN", "SM_PAGE_LOAD_BASELINE_MESSAGE", "SM_PAGE_LOAD_SCENARIO_MESSAGE", "SCENARIO_CREATE_FAILED_CONTEXT", "BASELINE_CREATE_FAILED_CONTEXT", "BASELINE_REVERT_FAILED_CONTEXT", "SM_SCHEDULE_SCENARIOS_IN_PROGRESS_INFO_BANNER", "SM_RELATED_ACTIVITY_HELP", "SM_GOTO_EXTERNAL_ACTIVITY", "SCHEDULE_HEALTH_SETTINGS_SUCCESS", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_SINGLE_WORKSPACE_SUCCESS_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_MULTIPLE_WORKSPACES_SUCCESS_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_SINGLE_PROJECT_SUCCESS_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_MULTIPLE_PROJECTS_SUCCESS_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_FAIL", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_WORKSPACES_FAIL_MESSAGE", "SCHEDULE_HEALTH_SETTINGS_APPLY_TO_PROJECTS_FAIL_MESSAGE", "LN_RECALCULATE_TASK_SUMMARY_CHECK_VIEW", "LN_RECALCULATE_TASK_SUMMARY_CHECK_FAILED_CONTEXT", "LN_RECALCULATE_TASK_SUMMARY_CHECK_WAITING_CONTEXT", "LN_RECALCULATE_TASK_SUMMARY_CHECK_WAITING_MESSAGE", "LN_RECALCULATE_TASK_SUMMARY_CHECK_UI_ERROR_CONTEXT", "LN_RECALCULATE_TASK_SUMMARY_CHECK_SUCCESS", "LN_RECALCULATE_TASK_SUMMARY_CHECK_SUCCESS_CONTEXT", "REPLACE_RESOURCE_SUCCESS_CONTEXT", "REPLACE_RESOURCE_SUCCESS_DESCRIPTION", "REPLACE_RESOURCE_FAILED_ERROR_CONTEXT", "REPLACE_RESOURCE_FAILED_ERROR_DESCRIPTION", "REPLACE_RESOURCE_SUCCESS_LOG", "REPLACE_RESOURCE_ERROR_LOG", "REPLACE_RESOURCE_FAILED", "WORK_RATE_SYNC_SUCCESS", "WORK_RATE_SYNC_TENANT_ERROR", "WORK_RATE_SYNC_WORKSPACE_ERROR", "LN_TASK_NOTIFICATION_FOR_PROPOSED_DUE_DATE_CONTEXT", "LN_TASK_NOTIFICATION_FOR_OVERDUE_CONTEXT", "LN_TASK_NOTIFICATION_FOR_PROPOSED_DUE_DATE", "LN_TASK_NOTIFICATION_FOR_OVERDUE", "LN_TASK_NOTIFICATION_FOR_PROPOSED_DUE_DATE_DESCRIPTION", "SET_ACTIVITY_SCENARIO_SUCCESS", "SET_ACTIVITY_SCENARIO_FAILURE", "SET_ACTIVITY_SCENARIO_SUCCESS_CONTEXT", "SET_ACTIVITY_SCENARIO_FAILURE_CONTEXT", "SCENARIO_CREATE_SUCCESS", "SCENARIO_CREATE_SUCCESS_CONTEXT", "SET_ACTIVITY_SCENARIO_MERGE_INPROGRESS", "MERGE_COMPLETED_SUCCESSFULLY_NOTIFY_DETAIL", "MERGE_COMPLETED_SUCCESSFULLY_SUMMARY", "MERGE_COMPLETED_SUCCESSFULLY_INBOX_DETAIL", "SCHEDULE_MERGE_COMPLETE_SUCCESS", "UNABLE_TO_COMPLETE_MERGE", "MERGE_FAILED_NOTIFY_MSG", "MERGE_FAILED_INBOX_MSG", "SCHEDULE_MERGE_ACTIVITY_UNIQUE_CODE_VIOLATION", "PARTNERUSER_CREATE_USER_SUCCESS", "PARTNERUSER_PASSWD_CHANGE_SUCCESS", "COMPANY_USER_EXISTS", "PR_ERROR_FINISH_BEFORE_START", "SU_EMAIL_INSTRUTIONS", "TM_ERROR_NO_TASKS_FOUND", "CONTRACT_LINK", "CONTRACT_SUBMIT_DIALOG_COMMENT", "CONTRACT_SUBMIT_DIALOG_INBOX", "CONTRACT_SUBMIT_DIALOG_HEADER", "CONTRACT_REJECT_DIALOG_COMMENT", "CONTRACT_REJECT_DIALOG_INBOX", "CONTRACT_REJECT_DIALOG_HEADER", "CONTRACT_APPROVAL_DIALOG_COMMENT", "CONTRACT_APPROVAL_DIALOG_INBOX", "CONTRACT_APPROVAL_DIALOG_HEADER", "CONTRACT_WITHDRAW_APPROVAL_DIALOG_COMMENT", "CONTRACT_WITHDRAW_APPROVAL_DIALOG_INBOX", "CONTRACT_WITHDRAW_APPROVAL_DIALOG_HEADER", "CONTRACT_CLOSE_DIALOG_COMMENT", "CONTRACT_CLOSE_DIALOG_INBOX", "CONTRACT_CLOSE_DIALOG_HEADER", "CONTRACT_REOPEN_DIALOG_COMMENT", "CONTRACT_REOPEN_DIALOG_INBOX", "CONTRACT_REOPEN_DIALOG_HEADER", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_REJECT", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "CONTRACT_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "COMMITMENT_LINK", "COMMITMENT_SUBMIT_DIALOG_COMMENT", "COMMITMENT_SUBMIT_DIALOG_INBOX", "COMMITMENT_SUBMIT_DIALOG_HEADER", "COMMITMENT_REJECT_DIALOG_COMMENT", "COMMITMENT_REJECT_DIALOG_INBOX", "COMMITMENT_REJECT_DIALOG_HEADER", "COMMITMENT_APPROVAL_DIALOG_COMMENT", "COMMITMENT_APPROVAL_DIALOG_INBOX", "COMMITMENT_APPROVAL_DIALOG_HEADER", "COMMITMENT_WITHDRAW_APPROVAL_DIALOG_COMMENT", "COMMITMENT_WITHDRAW_APPROVAL_DIALOG_INBOX", "COMMITMENT_WITHDRAW_APPROVAL_DIALOG_HEADER", "COMMITMENT_CLOSE_DIALOG_COMMENT", "COMMITMENT_CLOSE_DIALOG_INBOX", "COMMITMENT_CLOSE_DIALOG_HEADER", "COMMITMENT_REOPEN_DIALOG_COMMENT", "COMMITMENT_REOPEN_DIALOG_INBOX", "COMMITMENT_REOPEN_DIALOG_HEADER", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_REJECT", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "COMMITMENT_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "CHANGE_ORDER_LINK", "CHANGE_ORDER_SUBMIT_DIALOG_COMMENT", "CHANGE_ORDER_SUBMIT_DIALOG_INBOX", "CHANGE_ORDER_SUBMIT_DIALOG_HEADER", "CHANGE_ORDER_REJECT_DIALOG_COMMENT", "CHANGE_ORDER_REJECT_DIALOG_INBOX", "CHANGE_ORDER_REJECT_DIALOG_HEADER", "CHANGE_ORDER_APPROVAL_DIALOG_COMMENT", "CHANGE_ORDER_APPROVAL_DIALOG_INBOX", "CHANGE_ORDER_APPROVAL_DIALOG_HEADER", "CHANGE_ORDER_WITHDRAW_APPROVAL_DIALOG_COMMENT", "CHANGE_ORDER_WITHDRAW_APPROVAL_DIALOG_INBOX", "CHANGE_ORDER_WITHDRAW_APPROVAL_DIALOG_HEADER", "CHANGE_ORDER_CLOSE_COMMENT", "CHANGE_ORDER_REOPEN_COMMENT", "CHANGE_ORDER_REJECT_COMMENT", "CHANGE_ORDER_APPROVE_COMMENT", "CHANGE_ORDER_SUBMIT_COMMENT", "CHANGE_ORDER_WITHDRAW_COMMENT", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_REJECT", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_VOID", "POTENTIAL_CHANGE_ORDER_LINK", "POTENTIAL_CHANGE_ORDER_SUBMIT_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_SUBMIT_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_SUBMIT_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_REOPEN_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_REOPEN_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_REOPEN_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_CLOSE_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_CLOSE_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_CLOSE_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_WITHDRAW_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_WITHDRAW_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_WITHDRAW_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "POTENTIAL_CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "POTENTIAL_CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "POTENTIAL_CHANGE_ORDER_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "MANUAL_POTENTIAL_CHANGE_ORDER_DEFAULT_SUBMIT_COMMENT", "MANUAL_POTENTIAL_CHANGE_ORDER_DEFAULT_REOPEN_COMMENT", "MANUAL_POTENTIAL_CHANGE_ORDER_DEFAULT_CLOSE_COMMENT", "MANUAL_POTENTIAL_CHANGE_ORDER_DEFAULT_WITHDRAW_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_LINK", "POTENTIAL_CHANGE_ORDER_PROPOSAL_SUBMIT_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_SUBMIT_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_PROPOSAL_SUBMIT_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_PROPOSAL_REJECT_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_REJECT_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_PROPOSAL_REJECT_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_PROPOSAL_APPROVAL_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_APPROVAL_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_PROPOSAL_APPROVAL_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_PROPOSAL_WITHDRAW_APPROVAL_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_WITHDRAW_APPROVAL_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_PROPOSAL_WITHDRAW_APPROVAL_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_PROPOSAL_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_STATUS_CHANGE_EMAIL_TITLE_REJECT", "POTENTIAL_CHANGE_ORDER_PROPOSAL_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "POTENTIAL_CHANGE_ORDER_PROPOSAL_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_LINK", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_SUBMIT_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_SUBMIT_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_SUBMIT_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_ANSWER_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_ANSWER_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_ANSWER_DIALOG_HEADER", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_REOPEN_DIALOG_COMMENT", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_REOPEN_DIALOG_INBOX", "POTENTIAL_CHANGE_ORDER_CORRESPONDENCE_REOPEN_DIALOG_HEADER", "PAYMENT_APPLICATION_LINK", "PAYMENT_APPLICATION_SUBMIT_DIALOG_COMMENT", "PAYMENT_APPLICATION_SUBMIT_DIALOG_INBOX", "PAYMENT_APPLICATION_SUBMIT_DIALOG_HEADER", "PAYMENT_APPLICATION_REJECT_DIALOG_COMMENT", "PAYMENT_APPLICATION_REJECT_DIALOG_INBOX", "PAYMENT_APPLICATION_REJECT_DIALOG_HEADER", "PAYMENT_APPLICATION_APPROVAL_DIALOG_COMMENT", "PAYMENT_APPLICATION_APPROVAL_DIALOG_INBOX", "PAYMENT_APPLICATION_APPROVAL_DIALOG_HEADER", "PAYMENT_APPLICATION_WITHDRAW_APPROVAL_DIALOG_COMMENT", "PAYMENT_APPLICATION_WITHDRAW_APPROVAL_DIALOG_INBOX", "PAYMENT_APPLICATION_WITHDRAW_APPROVAL_DIALOG_HEADER", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_APPROVE", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_REJECT", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_WITHDRAW", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "PAYMENT_APPLICATION_STATUS_CHANGE_EMAIL_TITLE_VOID", "CHANGE_EVENTS_SUBMIT_DIALOG_COMMENT", "CHANGE_EVENTS_SUBMIT_DIALOG_INBOX", "CHANGE_EVENTS_SUBMIT_DIALOG_HEADER", "CHANGE_EVENTS_VOID_DIALOG_COMMENT", "CHANGE_EVENTS_VOID_DIALOG_INBOX", "CHANGE_EVENTS_VOID_DIALOG_HEADER", "CHANGE_EVENTS_CLOSED_DIALOG_COMMENT", "CHANGE_EVENTS_CLOSED_DIALOG_INBOX", "CHANGE_EVENTS_CLOSED_DIALOG_HEADER", "CHANGE_EVENTS_REOPEN_DIALOG_COMMENT", "CHANGE_EVENTS_REOPEN_DIALOG_INBOX", "CHANGE_EVENTS_REOPEN_DIALOG_HEADER", "CHANGE_EVENTS_LINK", "MANUAL_CHANGE_EVENTS_DEFAULT_SUBMIT_COMMENT", "MANUAL_CHANGE_EVENTS_DEFAULT_VOID_COMMENT", "MANUAL_CHANGE_EVENTS_DEFAULT_CLOSED_COMMENT", "MANUAL_CHANGE_EVENTS_DEFAULT_REOPEN_COMMENT", "CHANGE_STATUS_CHANGE_EMAIL_TITLE_SUBMIT", "CHANGE_STATUS_CHANGE_EMAIL_TITLE_CLOSE", "CHANGE_STATUS_CHANGE_EMAIL_TITLE_REOPEN", "CHANGE_STATUS_CHANGE_EMAIL_TITLE_VOID", "WORKSPACE_FUND_ALLOCATION_DISTRIBUTE_EVENLY_WARNING", "WORKSPACE_FUND_ALLOCATION_RESET_WARNING", "FUND_HAS_MANUALLY_APPROPRIATED_VALUES", "FUNDS_REFRESH_LINK", "FUND_TIMEPHASE_VALIDATE_DISTRIBUTED_TOTALS", "FUNDS_TIMEPHASE_CONFIRM_START_DATE", "FUNDS_TIMEPHASE_CONFIRM_END_DATE", "FUND_TIMEPHASE_EDIT_START_DATE", "FUND_CHECK_VALIDITY_WITH_ISSUES", "FUND_TIMEPHASE_EDIT_END_DATE", "BP_FUNDS_REMOVE_FUNDS", "BP_FUNDS_REMOVE_FUNDS_WITH_ALLOCATION", "BP_FUNDS_ERROR_REMOVE_FUNDS", "IMPORT_P6_SUCCES", "IMPORT_P6_SUCCESS_DESCRIPTION", "IMPORT_P6_FAIL", "IMPORT_P6_FAIL_DESCRIPTION_SINGLE_PROJECT", "IMPORT_P6_FAIL_DESCRIPTION_MULTIPLE_PROJECT", "IMPORT_LOG_CURVE_ENTITY", "IMPORT_LOG_CURVE", "CURVE_COUNT_CREATE", "CURVE_COUNT_UPDATE", "CURVE_COUNT_NOTIMPORT", "CURVE_IMPORT_FAIL", "IMPORT_LOG_CALENDAR_ENTITY", "IMPORT_LOG_CALENDAR", "CALENDAR_COUNT_CREATE", "CALENDAR_COUNT_UPDATE", "CALENDAR_COUNT_NOTIMPORT", "CALENDAR_IMPORT_FAIL", "CALENDAR_EXCEPTION_NOT_FOUND_TO_DELETE", "IMPORT_LOG_PROJECT_CALENDAR", "PROJECT_CALENDAR_COUNT_CREATE", "PROJECT_CALENDAR_COUNT_UPDATE", "PROJECT_CALENDAR_COUNT_NOTIMPORT", "IMPORT_LOG_CODE_ENTITY", "IMPORT_LOG_CODES", "IMPORT_LOG_PROJECT_CODE", "CODE_COUNT_CREATE", "PROJECT_CODE_COUNT_CREATE", "CODE_COUNT_UPDATE", "PROJECT_CODE_COUNT_UPDATE", "IMPORT_LOG_PROJECT_CODE_COUNT_FAILED", "CODE_COUNT_NOTIMPORT", "PROJECT_CODE_COUNT_NOTIMPORT", "CODE_IMPORT_FAIL", "CODE_VALUE_ASSIGNMENT_NOT_FOUND_TO_DELETE", "CUSTOM_LOG_OBJECT_CODE_VALUE_ASSIGNMENT_NOT_FOUND_TO_DELETE", "DOCUMENT_CODE_VALUE_ASSIGNMENT_NOT_FOUND_TO_DELETE", "IMPORT_LOG_CODE_VALUE_ENTITY", "IMPORT_LOG_CODE_VALUES", "IMPORT_LOG_PROJECT_CODE_VALUES", "CODE_VALUE_COUNT_CREATE", "PROJECT_CODE_VALUE_COUNT_CREATE", "CODE_VALUE_COUNT_UPDATE", "PROJECT_CODE_VALUE_COUNT_UPDATE", "CODE_VALUE_COUNT_NOTIMPORT", "PROJECT_CODE_VALUE_COUNT_NOTIMPORT", "CODE_VALUE_IMPORT_FAIL", "IMPORT_LOG_RESOURCE_ENTITY", "IMPORT_LOG_RESOURCES", "RESOURCE_COUNT_CREATE", "RESOURCE_COUNT_UPDATE", "RESOURCE_COUNT_NOTIMPORT", "RESOURCE_IMPORT_FAIL", "IMPORT_LOG_RESOURCERATE_ENTITY", "IMPORT_LOG_RESOURCERATES", "RESOURCERATE_COUNT_CREATE", "RESOURCERATE_COUNT_UPDATE", "RESOURCERATE_COUNT_NOTIMPORT", "RESOURCERATE_IMPORT_FAIL", "IMPORT_LOG_ROLE_ENTITY", "IMPORT_LOG_ROLES", "ROLE_COUNT_CREATE", "ROLE_COUNT_UPDATE", "ROLE_COUNT_NOTIMPORT", "ROLE_IMPORT_FAIL", "IMPORT_LOG_ROLELIMIT_ENTITY", "IMPORT_LOG_ROLELIMITS", "ROLELIMIT_COUNT_CREATE", "ROLELIMIT_COUNT_UPDATE", "ROLELIMIT_COUNT_NOTIMPORT", "ROLELIMIT_IMPORT_FAIL", "IMPORT_LOG_PROJECT_ENTITY", "IMPORT_LOG_PROJECTS", "PROJECT_COUNT_CREATE", "PROJECT_COUNT_UPDATE", "PROJECT_COUNT_NOTIMPORT", "PROJECT_IMPORT_FAIL", "IMPORT_LOG_BASELINE_PROJECT_ENTITY", "IMPORT_LOG_BASELINE_PROJECTS", "BASELINE_PROJECT_COUNT_CREATE", "BASELINE_PROJECT_COUNT_UPDATE", "BASELINE_PROJECT_COUNT_NOTIMPORT", "BASELINE_PROJECT_COUNT_FAILED", "IMPORT_LOG_SCENARIO_PROJECT_ENTITY", "IMPORT_LOG_SCENARIO_PROJECTS", "SCENARIO_PROJECT_COUNT_CREATE", "SCENARIO_PROJECT_COUNT_UPDATE", "SCENARIO_PROJECT_COUNT_NOTIMPORT", "SCENARIO_PROJECT_COUNT_FAILED", "IMPORT_LOG_IMPORT_ACTION_DETAILS", "IMPORT_LOG_CURRENT_SCHEDULE", "IMPORT_LOG_DETAIL_IMPORT_ACTION_CREATE_NEW_PROJECT", "IMPORT_LOG_DETAIL_IMPORT_ACTION_UPDATE_EXISTING_PROJECT", "IMPORT_LOG_DETAIL_IMPORT_ACTION_CREATE_NEW_BASELINE", "IMPORT_LOG_DETAIL_IMPORT_ACTION_UPDATE_EXISTING_BASELINE", "IMPORT_LOG_DETAIL_IMPORT_ACTION_CREATE_NEW_SCENARIO", "IMPORT_LOG_DETAIL_IMPORT_ACTION_UPDATE_EXISTING_SCENARIO", "IMPORT_LOG_DETAIL_MESSAGE_BASELINE_CREATED_NEW", "IMPORT_LOG_DETAIL_MESSAGE_SCENARIO_CREATED_NEW", "IMPORT_LOG_DETAIL_MESSAGE_ORIGINAL_BASELINE_CREATED_NEW", "IMPORT_LOG_DETAIL_MESSAGE_BASELINE_UPDATED_EXISTING", "IMPORT_LOG_DETAIL_MESSAGE_SCENARIO_UPDATED_EXISTING", "IMPORT_LOG_DETAIL_MESSAGE_PROJECT_UPDATED_EXISTING", "IMPORT_LOG_DETAIL_MESSAGE_NOT_IMPORTED", "SUMMARY_TOTAL_COUNT_CREATE", "SUMMARY_TOTAL_COUNT_UPDATE", "SUMMARY_TOTAL_COUNT_NOTIMPORT", "SUMMARY_TOTAL_COUNT_FAIL", "IMPORT_LOG_BASELINE_RELATIONSHIPS", "BASELINE_RELATIONSHIP_COUNT_CREATE", "BASELINE_RELATIONSHIP_COUNT_UPDATE", "BASELINE_RELATIONSHIP_COUNT_NOTIMPORT", "BASELINE_RELATIONSHIP_COUNT_DELETE", "BASELINE_RELATIONSHIP_COUNT_FAILED", "PROJECT_EXTERNAL_COUNT_CREATE", "PROJECT_EXTERNAL_IMPORT_FAIL", "IMPORT_LOG_NOTEBOOKTOPIC_ENTITY", "IMPORT_LOG_NOTEBOOKTOPIC", "IMPORT_LOG_ACTIVITY_NOTES", "NOTEBOOKTOPIC_COUNT_CREATE", "NOTEBOOKTOPIC_COUNT_UPDATE", "NOTEBOOKTOPIC_COUNT_NOTIMPORT", "NOTEBOOKTOPIC_COUNT_FAILED", "IMPORT_LOG_UNITSOFMEASURE_ENTITY", "IMPORT_LOG_UNITSOFMEASURE", "UNITSOFMEASURE_COUNT_CREATE", "UNITSOFMEASURE_COUNT_UPDATE", "UNITSOFMEASURE_COUNT_NOTIMPORT", "UNITSOFMEASURE_IMPORT_FAIL", "UNITSOFMEASURE_DISPLAY_NAME", "IMPORT_LOG_ACTIVITY_ENTITY", "IMPORT_LOG_ACTIVITIES", "ACTIVITY_COUNT_CREATE", "ACTIVITY_COUNT_UPDATE", "ACTIVITY_COUNT_DELETE", "ACTIVITY_COUNT_NOTIMPORT", "ACTIVITY_IMPORT_FAIL", "IMPORT_LOG_BASELINE_ACTIVITY_ENTITY", "IMPORT_LOG_BASELINE_ACTIVITIES", "BASELINE_ACTIVITY_COUNT_CREATE", "BASELINE_ACTIVITY_COUNT_UPDATE", "BASELINE_ACTIVITY_COUNT_DELETE", "BASELINE_ACTIVITY_COUNT_NOTIMPORT", "BASELINE_ACTIVITY_IMPORT_FAIL", "IMPORT_LOG_SCENARIO_ACTIVITIES", "SCENARIO_ACTIVITY_COUNT_CREATE", "SCENARIO_ACTIVITY_COUNT_UPDATE", "SCENARIO_ACTIVITY_COUNT_DELETE", "SCENARIO_ACTIVITY_COUNT_NOTIMPORT", "SCENARIO_ACTIVITY_IMPORT_FAIL", "IMPORT_LOG_ASSIGNMENT_ENTITY", "IMPORT_LOG_ASSIGNMENTS", "ASSIGNMENT_COUNT_CREATE", "ASSIGNMENT_COUNT_UPDATE", "ASSIGNMENT_COUNT_NOTIMPORT", "ASSIGNMENT_COUNT_DELETE", "ASSIGNMENT_IMPORT_FAIL", "IMPORT_LOG_BASELINE_ASSIGNMENT_ENTITY", "IMPORT_LOG_BASELINE_ASSIGNMENTS", "BASELINE_ASSIGNMENT_COUNT_CREATE", "BASELINE_ASSIGNMENT_COUNT_UPDATE", "BASELINE_ASSIGNMENT_COUNT_NOTIMPORT", "BASELINE_ASSIGNMENT_COUNT_DELETE", "BASELINE_ASSIGNMENT_IMPORT_FAIL", "IMPORT_LOG_SCENARIO_ASSIGNMENT_ENTITY", "IMPORT_LOG_SCENARIO_ASSIGNMENTS", "SCENARIO_ASSIGNMENT_COUNT_CREATE", "SCENARIO_ASSIGNMENT_COUNT_UPDATE", "SCENARIO_ASSIGNMENT_COUNT_NOTIMPORT", "SCENARIO_ASSIGNMENT_COUNT_DELETE", "SCENARIO_ASSIGNMENT_IMPORT_FAIL", "IMPORT_LOG_RELATIONSHIP_ENTITY", "IMPORT_LOG_RELATIONSHIPS", "RELATIONSHIP_COUNT_CREATE", "RELATIONSHIP_COUNT_UPDATE", "RELATIONSHIP_COUNT_NOTIMPORT", "RELATIONSHIP_COUNT_DELETE", "RELATIONSHIP_IMPORT_FAIL", "IMPORT_LOG_SCENARIO_RELATIONSHIPS", "SCENARIO_RELATIONSHIP_COUNT_CREATE", "SCENARIO_RELATIONSHIP_COUNT_UPDATE", "SCENARIO_RELATIONSHIP_COUNT_NOTIMPORT", "SCENARIO_RELATIONSHIP_COUNT_DELETE", "SCENARIO_RELATIONSHIP_COUNT_FAILED", "IMPORT_LOG_WBS", "WBS_COUNT_CREATE", "WBS_COUNT_UPDATE", "WBS_COUNT_NOTIMPORT", "WBS_IMPORT_FAIL", "WBS_DELETE_SUCCESS", "WBS_DELETE_FAIL", "IMPORT_LOG_BASELINE_WBS", "IMPORT_LOG_BASELINE_WBS_ENTITY", "BASELINE_WBS_COUNT_CREATE", "BASELINE_WBS_COUNT_UPDATE", "BASELINE_WBS_COUNT_NOTIMPORT", "BASELINE_WBS_COUNT_FAILED", "BASELINE_WBS_IMPORT_FAIL", "BASELINE_WBS_COUNT_DELETE", "IMPORT_LOG_SCENARIO_WBS", "SCENARIO_WBS_COUNT_CREATE", "SCENARIO_WBS_COUNT_UPDATE", "SCENARIO_WBS_COUNT_DELETE", "SCENARIO_WBS_COUNT_NOTIMPORT", "SCENARIO_WBS_COUNT_FAILED", "SCENARIO_WBS_IMPORT_FAIL", "IMPORT_LOG_ASSIGNMENTUDFS", "ASSIGNMENTUDF_COUNT_TOTAL", "ASSIGNMENTUDF_COUNT_CREATE", "ASSIGNMENTUDF_COUNT_UPDATE", "ASSIGNMENTUDF_COUNT_NOTIMPORT", "ASSIGNMENTUDF_COUNT_FAILED", "ASSIGNMENTUDF_IMPORT_FAIL", "IMPORT_LOG_ACTIVITYUDFS", "ACTIVITYUDF_COUNT_TOTAL", "ACTIVITYUDF_COUNT_CREATE", "ACTIVITYUDF_COUNT_UPDATE", "ACTIVITYUDF_COUNT_NOTIMPORT", "ACTIVITYUDF_COUNT_FAILED", "ACTIVITYUDF_IMPORT_FAIL", "IMPORT_LOG_WBSUDFS", "WBSUDF_COUNT_TOTAL", "WBSUDF_COUNT_CREATE", "WBSUDF_COUNT_UPDATE", "WBSUDF_COUNT_NOTIMPORT", "WBSUDF_COUNT_FAILED", "WBSUDF_IMPORT_FAIL", "IMPORT_LOG_PROJECTUDFS", "PROJECTUDF_COUNT_TOTAL", "PROJECTUDF_COUNT_CREATE", "PROJECTUDF_COUNT_UPDATE", "PROJECTUDF_COUNT_NOTIMPORT", "PROJECTUDF_COUNT_FAILED", "PROJECTUDF_IMPORT_FAIL", "IMPORT_LOG_RISKUDFS", "RISKUDF_COUNT_TOTAL", "RISKUDF_COUNT_CREATE", "RISKUDF_COUNT_UPDATE", "RISKUDF_COUNT_NOTIMPORT", "RISKUDF_COUNT_FAILED", "RISKUDF_IMPORT_FAIL", "IMPORT_LOG_RISKSCORETYPE_ENTITY", "IMPORT_LOG_RISKSCORETYPE", "RISKSCORETYPE_COUNT_CREATE", "RISKSCORETYPE_COUNT_UPDATE", "RISKSCORETYPE_COUNT_NOTIMPORT", "RISKSCORETYPE_IMPORT_FAIL", "IMPORT_LOG_RISKMATRIX_ENTITY", "IMPORT_LOG_RISKMATRIX", "RISKMATRIX_COUNT_CREATE", "RISKMATRIX_COUNT_UPDATE", "RISKMATRIX_COUNT_NOTIMPORT", "RISKMATRIX_IMPORT_FAIL", "IMPORT_LOG_PROJECTRISK_ENTITY", "IMPORT_LOG_PROJECTRISKS", "PROJECTRISKS_COUNT_CREATE", "PROJECTRISKS_COUNT_UPDATE", "PROJECTRISKS_COUNT_DELETE", "PROJECTRISKS_COUNT_NOTIMPORT", "PROJECTRISKS_IMPORT_FAIL", "IMPORT_LOG_ACTIVITYRISK_ENTITY", "IMPORT_LOG_ACTIVITYRISKS", "ACTIVITYRISKS_COUNT_TOTAL", "ACTIVITYRISKS_COUNT_CREATE", "ACTIVITYRISKS_COUNT_UPDATE", "ACTIVITYRISKS_COUNT_NOTIMPORT", "ACTIVITYRISKS_COUNT_DELETE", "ACTIVITYRISKS_IMPORT_FAIL", "IMPORT_LOG_RISKMITIGATION_ENTITY", "IMPORT_LOG_RISKMITIGATION", "RISKMITIGATION_COUNT_TOTAL", "RISKMITIGATION_COUNT_CREATE", "RISKMITIGATION_COUNT_UPDATE", "RISKMITIGATION_COUNT_NOTIMPORT", "RISKMITIGATION_COUNT_DELETE", "RISKMITIGATION_IMPORT_FAIL", "IMPORT_LOG_RESOURCEROLEASSIGNMENT_ENTITY", "IMPORT_LOG_RESOURCEROLEASSIGNMENTS", "RESOURCEROLEASSIGNMENT_COUNT_CREATE", "RESOURCEROLEASSIGNMENT_COUNT_UPDATE", "RESOURCEROLEASSIGNMENT_COUNT_NOTIMPORT", "RESOURCEROLEASSIGNMENT_COUNT_DELETE", "PROJECT_COUNT_FAILED", "RESOURCE_COUNT_FAILED", "CALENDAR_COUNT_FAILED", "PROJECT_CALENDAR_COUNT_FAILED", "CODE_COUNT_FAILED", "CODE_VALUE_COUNT_FAILED", "CURVE_COUNT_FAILED", "RESOURCERATE_COUNT_FAILED", "ROLE_COUNT_FAILED", "ROLELIMIT_COUNT_FAILED", "ACTIVITY_COUNT_FAILED", "ASSIGNMENT_COUNT_FAILED", "RELATIONSHIP_COUNT_FAILED", "WBS_COUNT_FAILED", "RISKMATRIX_COUNT_FAILED", "RISKSCORETYPE_COUNT_FAILED", "PROJECTRISKS_COUNT_FAILED", "ACTIVITYRISKS_COUNT_FAILED", "RISKMITIGATION_COUNT_FAILED", "RESOURCEROLEASSIGNMENT_COUNT_FAILED", "UNITSOFMEASURE_COUNT_FAILED", "FORM_TASK_DRAFT_NOTIFICATION", "SHARED_DATA_CONFIRM_REMOVE", "IMPORT_LOG_BASELINE_CATEGORY_ENTITY", "IMPORT_LOG_BASELINE_CATEGORY", "BASELINE_CATEGORY_COUNT_CREATE", "BASELINE_CATEGORY_COUNT_UPDATE", "BASELINE_CATEGORY_COUNT_NOTIMPORT", "BASELINE_CATEGORY_COUNT_IMPORT_FAILED", "IMPORT_LOG_BASELINE_CATEGORY_MULTIPLE_ENTITY_FOUND_NEW_ENTITY_CREATED", "PORTFOLIO_MEASURE_RECALCULATE_MEASURE_SUCCESFUL", "PORTFOLIO_MEASURE_RECALCULATE_MEASURE_FOR_PORTFOLIOS_SUCCESFUL", "PORTFOLIO_MEASURE_RECALCULATE_MEASURE_FOR_PORTFOLIOS_FAILED", "MEASURES_ACTUAL_EXPRESSION_REQUIRED", "MEASURE_VALIDATION_SUCCESSFUL_DETAIL", "WORKSPACE_MEASURE_RECALCULATE_SUCCESSFUL", "WORKSPACE_MEASURE_RECALCULATE_FAILED", "PROJECT_MEASURE_BY_PORTFOLIO_RECALCULATE_SUCCESSFUL", "PROJECT_MEASURE_BY_PORTFOLIO_RECALCULATE_FAILED", "WORKSPACE_MEASURE_PROGRAMS_RECALCULATE_SUCCESSFUL", "WORKSPACE_MEASURE_PROGRAMS_RECALCULATE_FAILED", "PROGRAM_MEASURES_BY_PORTFOLIO_RECALCULATE_SUCCESSFUL", "PROGRAM_MEASURES_BY_PORTFOLIO_RECALCULATE_FAILED", "WORKSPACE_MOVE_FAILED", "WORKSPACE_MOVE_FAILURE_REASON", "WORKSPACE_MOVE_COMPLETED", "WORKSPACE_MOVE_RECORD_NOT_SAVED", "WORKSPACE_MOVE_RECORD_SAVED", "WORKSPACE_MOVE_RENAMED", "MOVE_LOG_LOCATION_ENTITY", "WORKSPACE_MOVE_EVAL_REASON", "WORKSPACE_MOVE_EVAL_RECOMMENDATION", "WORKSPACE_MOVE_RECOMMENDATION", "WORKSPACE_MOVE_CBS_REASON", "WORKSPACE_MOVE_CBS_RECOMMENDATION", "WORKSPACE_MOVE_WORKFLOW_CONFIGURATION_REASON", "WORKSPACE_MOVE_WORKFLOW_CONFIGURATION_RECOMMENDATION", "WORKSPACE_MOVE_SECURITY_PROFILE_COUNT_MOVED", "WORKSPACE_MOVE_FORM_COUNT_MOVED", "WORKSPACE_MOVE_WORKFLOW_CONFIG_COUNT_MOVED", "WORKSPACE_MOVE_WORKFLOW_DESIGN_COUNT_MOVED", "MOVE_LOG_WORKFLOW_CONFIGURATION_ENTITY", "MOVE_LOG_WORKFLOW_DESIGN_ENTITY", "WORKSPACE_MOVE_USERS_ACCESS_COUNT_MOVED", "WORKSPACE_MOVE_USER_GROUP_COUNT_MOVED", "WORKSPACE_MOVE_NOTEBOOKTOPIC_COUNT_MOVED", "WORKSPACE_MOVE_NOTEBOOKTOPIC_COUNT_RENAMED", "WORKSPACE_MOVE_NOTEBOOKTOPIC_COUNT_REMOVED", "MOVE_LOG_NOTEBOOKTOPIC_ENTITY", "WORKSPACE_MOVE_COLUMN_DEFINITION_RELATIONSHIP_LIST_REASON", "WORKSPACE_DELETE_ERRORS", "WORKSPACE_TOTAL_COUNT_ERRORS", "WORKSPACE_DELETE_FAILED", "WORKSPACE_DELETE_COMPLETED", "WORKSPACE_DELETE_RECORD_NOT_SAVED", "WORKSPACE_DELETE_RECORD_SAVED", "WORKSPACE_DELETE_RENAMED", "WORKSPACE_DELETE_ID_UPDATED", "WORKSPACE_DELETE_MOVED", "WORKSPACE_DELETE_USERGROUPS", "WORKSPACE_DELETE_CBS_REASON", "WORKSPACE_DELETE_CBS_RECOMMENDATION", "WORKSPACE_DELETE_FAILURE_REASON", "WORKSPACE_DELETE_FAILURE_RECOMMENDATION", "WORKSPACE_DELETE_EVAL_REASON", "WORKSPACE_DELETE_EVAL_RECOMMENDATION", "WORKSPACE_DELETE_FAILURE_RELATIONSHIP_REASON", "WORKSPACE_DELETE_FAILURE_RELATIONSHIP_RECOMMENDATION", "WORKSPACE_DELETE_ANALYSIS_VIEW_COUNT_MOVED", "WORKSPACE_DELETE_ANALYSIS_VIEW_COUNT_RENAMED", "WORKSPACE_DELETE_ANALYSIS_VIEW_COUNT_REMOVED", "WORKSPACE_DELETE_BASELINE_CATEGORY_COUNT_MOVED", "WORKSPACE_DELETE_BASELINE_CATEGORY_COUNT_RENAMED", "WORKSPACE_DELETE_BASELINE_CATEGORY_COUNT_REMOVED", "WORKSPACE_DELETE_CALENDAR_COUNT_MOVED", "WORKSPACE_DELETE_CALENDAR_COUNT_RENAMED", "WORKSPACE_DELETE_CALENDAR_COUNT_REMOVED", "WORKSPACE_DELETE_CODES_COUNT_MOVED", "WORKSPACE_DELETE_CODES_COUNT_RENAMED", "WORKSPACE_DELETE_CODES_COUNT_REMOVED", "WORKSPACE_DELETE_COST_CATEGORY_COUNT_MOVED", "WORKSPACE_DELETE_COST_CATEGORY_COUNT_RENAMED", "WORKSPACE_DELETE_COST_CATEGORY_COUNT_REMOVED", "WORKSPACE_DELETE_CURRENCY_COUNT_MOVED", "WORKSPACE_DELETE_CURRENCY_COUNT_RENAMED", "WORKSPACE_DELETE_CURRENCY_COUNT_REMOVED", "WORKSPACE_DELETE_CURVE_COUNT_MOVED", "WORKSPACE_DELETE_CURVE_COUNT_RENAMED", "WORKSPACE_DELETE_CURVE_COUNT_REMOVED", "WORKSPACE_DELETE_CUSTOM_LOG_COUNT_MOVED", "WORKSPACE_DELETE_CUSTOM_LOG_COUNT_RENAMED", "WORKSPACE_DELETE_CUSTOM_LOG_COUNT_REMOVED", "WORKSPACE_DELETE_CONFIGURED_FIELDS_COUNT_MOVED", "WORKSPACE_DELETE_CONFIGURED_FIELDS_COUNT_RENAMED", "WORKSPACE_DELETE_CONFIGURED_FIELDS_COUNT_REMOVED", "WORKSPACE_DELETE_DASHBOARD_COUNT_MOVED", "WORKSPACE_DELETE_DASHBOARD_COUNT_RENAMED", "WORKSPACE_DELETE_DASHBOARD_COUNT_REMOVED", "WORKSPACE_DELETE_DASHBOARD_IMAGE_COUNT_MOVED", "WORKSPACE_DELETE_DASHBOARD_IMAGE_COUNT_RENAMED", "WORKSPACE_DELETE_DASHBOARD_IMAGE_COUNT_REMOVED", "WORKSPACE_DELETE_DOCUMENTS_COUNT_MOVED", "WORKSPACE_DELETE_DOCUMENTS_COUNT_RENAMED", "WORKSPACE_DELETE_DOCUMENTS_COUNT_REMOVED", "WORKSPACE_DELETE_EVALUATION_SUB_CATEGORY_COUNT_MOVED", "WORKSPACE_DELETE_EVALUATION_SUB_CATEGORY_COUNT_RENAMED", "WORKSPACE_DELETE_EVALUATION_SUB_CATEGORY_COUNT_REMOVED", "WORKSPACE_DELETE_FMS_COUNT_MOVED", "WORKSPACE_DELETE_FMS_COUNT_RENAMED", "WORKSPACE_DELETE_FMS_COUNT_REMOVED", "WORKSPACE_DELETE_FILTER", "WORKSPACE_DELETE_FILTER_COUNT_MOVED", "WORKSPACE_DELETE_FILTER_COUNT_RENAMED", "WORKSPACE_DELETE_FILTER_COUNT_REMOVED", "WORKSPACE_DELETE_FORM_REASON", "WORKSPACE_DELETE_FORM_RECOMMENDATION", "WORKSPACE_DELETE_FORM_COUNT_MOVED", "WORKSPACE_DELETE_FORM_COUNT_RENAMED", "WORKSPACE_DELETE_FORM_COUNT_REMOVED", "WORKSPACE_DELETE_FUND_COUNT_MOVED", "WORKSPACE_DELETE_FUND_COUNT_RENAMED", "WORKSPACE_DELETE_FUND_COUNT_REMOVED", "WORKSPACE_DELETE_HOLIDAY_COUNT_MOVED", "WORKSPACE_DELETE_HOLIDAY_COUNT_RENAMED", "WORKSPACE_DELETE_HOLIDAY_COUNT_REMOVED", "WORKSPACE_DELETE_IDEA_COUNT_MOVED", "WORKSPACE_DELETE_IDEA_COUNT_RENAMED", "WORKSPACE_DELETE_IDEA_COUNT_REMOVED", "WORKSPACE_DELETE_INSIGHT_COUNT_MOVED", "WORKSPACE_DELETE_INSIGHT_COUNT_RENAMED", "WORKSPACE_DELETE_INSIGHT_COUNT_REMOVED", "WORKSPACE_DELETE_LOCATION_COUNT_MOVED", "WORKSPACE_DELETE_LOCATION_COUNT_RENAMED", "WORKSPACE_DELETE_LOCATION_COUNT_REMOVED", "LOCATION_COUNT_MOVED", "LOCATION_COUNT_RENAMED", "ROLES_RESOURCE_COUNT_MOVED", "FMS_COUNT_MOVED", "WORKSPACE_DELETE_MEASURE_COUNT_MOVED", "WORKSPACE_DELETE_MEASURE_COUNT_RENAMED", "WORKSPACE_DELETE_MEASURE_COUNT_REMOVED", "WORKSPACE_DELETE_PORTFOLIO_COUNT_MOVED", "WORKSPACE_DELETE_PORTFOLIO_COUNT_RENAMED", "WORKSPACE_DELETE_PORTFOLIO_COUNT_REMOVED", "WORKSPACE_DELETE_PROJECT_COUNT_MOVED", "WORKSPACE_DELETE_PROJECT_COUNT_RENAMED", "WORKSPACE_DELETE_PROJECT_COUNT_REMOVED", "WORKSPACE_DELETE_PROGRAM_COUNT_MOVED", "WORKSPACE_DELETE_PROGRAM_COUNT_RENAMED", "WORKSPACE_DELETE_PROGRAM_COUNT_REMOVED", "WORKSPACE_DELETE_RC_COUNT_MOVED", "WORKSPACE_DELETE_RC_COUNT_RENAMED", "WORKSPACE_DELETE_RC_COUNT_REMOVED", "WORKSPACE_DELETE_REASON_COUNT_MOVED", "WORKSPACE_DELETE_REASON_COUNT_RENAMED", "WORKSPACE_DELETE_REASON_COUNT_REMOVED", "WORKSPACE_DELETE_REPORT_COUNT_MOVED", "WORKSPACE_DELETE_REPORT_COUNT_RENAMED", "WORKSPACE_DELETE_REPORT_COUNT_REMOVED", "WORKSPACE_DELETE_ROLE_RESOURCE", "WORKSPACE_DELETE_RESOURCE_COUNT_MOVED", "WORKSPACE_DELETE_RESOURCE_COUNT_RENAMED", "WORKSPACE_DELETE_RESOURCE_COUNT_REMOVED", "WORKSPACE_DELETE_RISK_MATRIX_COUNT_MOVED", "WORKSPACE_DELETE_RISK_MATRIX_COUNT_RENAMED", "WORKSPACE_DELETE_RISK_MATRIX_COUNT_REMOVED", "WORKSPACE_DELETE_RISK_SCORE_TYPE_COUNT_MOVED", "WORKSPACE_DELETE_RISK_SCORE_TYPE_COUNT_RENAMED", "WORKSPACE_DELETE_RISK_SCORE_TYPE_COUNT_REMOVED", "WORKSPACE_DELETE_ROC_COUNT_MOVED", "WORKSPACE_DELETE_ROC_COUNT_RENAMED", "WORKSPACE_DELETE_ROC_COUNT_REMOVED", "WORKSPACE_DELETE_STRATEGY_COUNT_MOVED", "WORKSPACE_DELETE_STRATEGY_COUNT_RENAMED", "WORKSPACE_DELETE_STRATEGY_COUNT_REMOVED", "WORKSPACE_DELETE_STRATEGY_TYPE_COUNT_MOVED", "WORKSPACE_DELETE_STRATEGY_TYPE_COUNT_RENAMED", "WORKSPACE_DELETE_STRATEGY_TYPE_COUNT_REMOVED", "WORKSPACE_DELETE_SECURITY_PROFILE_COUNT_MOVED", "WORKSPACE_DELETE_SECURITY_PROFILE_COUNT_RENAMED", "WORKSPACE_DELETE_SECURITY_PROFILE_COUNT_REMOVED", "WORKSPACE_DELETE_UOM_COUNT_MOVED", "WORKSPACE_DELETE_UOM_COUNT_RENAMED", "WORKSPACE_DELETE_UOM_COUNT_REMOVED", "WORKSPACE_DELETE_USERS_COUNT_MOVED", "WORKSPACE_DELETE_USERS_COUNT_RENAMED", "WORKSPACE_DELETE_USERS_COUNT_REMOVED", "WORKSPACE_DELETE_USER_GROUP_COUNT_MOVED", "WORKSPACE_DELETE_USER_GROUP_COUNT_RENAMED", "WORKSPACE_DELETE_USER_GROUP_COUNT_REMOVED", "WORKSPACE_DELETE_VIEW_COUNT_MOVED", "WORKSPACE_DELETE_VIEW_COUNT_RENAMED", "WORKSPACE_DELETE_VIEW_COUNT_REMOVED", "WORKSPACE_DELETE_WORKFLOW_CONFIG_COUNT_MOVED", "WORKSPACE_DELETE_WORKFLOW_CONFIG_COUNT_RENAMED", "WORKSPACE_DELETE_WORKFLOW_CONFIG_COUNT_REMOVED", "WORKSPACE_DELETE_WORKFLOW_DESIGN_COUNT_MOVED", "WORKSPACE_DELETE_WORKFLOW_DESIGN_COUNT_RENAMED", "WORKSPACE_DELETE_WORKFLOW_DESIGN_COUNT_REMOVED", "WORKSPACE_DELETE_WORKFLOW_INSTANCE_COUNT_MOVED", "WORKSPACE_DELETE_WORKFLOW_INSTANCE_COUNT_RENAMED", "WORKSPACE_DELETE_WORKFLOW_INSTANCE_COUNT_REMOVED", "WORKSPACE_DELETE_WORKSPACE_COUNT_MOVED", "WORKSPACE_DELETE_WORKSPACE_COUNT_RENAMED", "WORKSPACE_DELETE_WORKSPACE_COUNT_REMOVED", "WORKSPACE_HARD_DELETE_NOTIFY_INITIATE", "WORKSPACE_HARD_DELETE_NOTIFY_INITIATE_DESCRIPTION", "WORKSPACE_HARD_DELETE_NOTIFY_SUCCESSFUL", "WORKSPACE_HARD_DELETE_NOTIFY_SUCCESSFUL_DESCRIPTION", "WORKSPACE_HARD_DELETE_NOTIFY_INCOMPLETE", "WORKSPACE_HARD_DELETE_NOTIFY_INCOMPLETE_DESCRIPTION", "WORKSPACE_HARD_DELETE_NOTIFY_FAILED", "WORKSPACE_HARD_DELETE_NOTIFY_FAILED_DESCRIPTION", "WORKSPACE_HARD_DELETE_VIEW_LOG_FAILED", "VALIDATION_UNIQUENESS_INFO", "VALIDATION_UNIQUENESS_CONFLICT_CONFIRM", "VALIDATION_UNIQUENESS_CONFLICT_SUBHEAD", "CLOSEOUT_PERIOD_COMPLETED_NAME", "CLOSEOUT_PERIOD_COMPLETED_DESCRIPTION", "PROXYUSER_ASSIGNED_NOTIFICATION", "PROXYUSER_PERIOD_START_NOTIFICATION", "PROXYUSER_PERIOD_END_NOTIFICATION", "PROXYUSER_ACCEPT_CONSENT_NOTICE", "GET_PRIME_EMAIL_SUBJECT", "GET_PRIME_EMAIL_TITLE", "GET_PRIME_EMAIL_BUTTON", "GET_PRIME_EMAIL_APP_STORE_LINK", "GET_PRIME_EMAIL_DESCRIPTION", "GET_PRIME_EMAIL_INSTRUCTIONS", "PORTFOLIO_AUTO_REFRESH_SUCCESS_HEADER", "PORTFOLIO_AUTO_REFRESH_SUCCESS_DETAIL", "PORTFOLIO_AUTO_REFRESH_FAILURE_HEADER", "PORTFOLIO_AUTO_REFRESH_FAILURE_DETAIL", "TASK_DUE_DATE_ON_NON_WORK_DAY", "TASK_COMPLETED_DATE_IN_FUTURE", "TASK_COMPLETED_DATE_AFTER_LATEST_COMMITMENT", "TASK_OUTSIDE_PLANNING_PERIOD", "TASKS_PLANNING_PERIOD_EARLY_BOUND_MAX", "TASKS_PLANNING_PERIOD_LATE_BOUND_MAX", "TASKS_CONFIRM_DELETE_COMMITMENT", "TASKS_CONFIRM_DELETE_LAST_COMMITMENT", "TASKS_CONFIRM_ADD_COMMITMENT_SAME_DATE", "WORK_MANAGEMENT_TASKS_REFRESH_LINK", "WORK_MANAGEMENT_FILTER_ALL_WEEKS_HINT", "TASK_COMPLETED_DATE_ON_NON_WORK_DAY", "TASK_MANAGEMENT_TASK_ACCEPT_PROPOSED_DUE_DATE_CONFIRMATION", "TASKS_COPY_PASTE_SUCCESS", "TASKS_COPY_PASTE_FAIL", "CAP_PLAN_ALLOCATION_APPROVED_BY", "CAP_PLAN_REVIEWED_AND_COMMITTED", "CAP_PLAN_VIEW_RESOURCE_DEMANDS", "DOCEXCHANGE_EMPTY_STATE_MESSAGE", "DOCEXCHANGE_REVISION_NEEDED", "DOCEXCHANGE_SET_AS_DRAFT", "DOCEXCHANGE_CANCEL", "DOCEXCHANGE_CHANGE_COMPANY", "RP_NON_TIME_PHASE_GRID_MODIFIES_SPREAD_DATA", "RP_SCENARIO_UNDER_REVIEW_NOTIFICATION_HEADER", "RP_SCENARIO_UNDER_REVIEW_NOTIFICATION_DESCRIPTION", "RP_SCENARIO_UNDER_APPROVAL_NOTIFICATION_HEADER", "RP_SCENARIO_UNDER_APPROVAL_NOTIFICATION_DESCRIPTION", "RP_SCENARIO_UNDER_DELETION_NOTIFICATION", "RM_RECALCULATE_RESOURCE_ASSIGNMENT", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_PROJECT_OWNER_SUCCESS_HEADER", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_PROJECT_OWNER_SUCCESS_DESC", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "RM_RESOURCE_APPROVAL_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_PROJECT_OWNER_SUCCESS_HEADER", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_PROJECT_OWNER_SUCCESS_DESC", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "RM_RESOURCE_PROPOSE_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "RM_RESOURCEPLANNING_SWITCH_SCENARIO_CONFIRMATION", "RM_RESOURCE_SCENARIO_PROJECT_COST_REFRESH_SUCCESS_HEADER", "RM_RESOURCE_SCENARIO_PROJECT_COST_REFRESH_SUCCESS_DESC", "RM_RESOURCE_SCENARIO_PROJECT_COST_REFRESH_FAILURE_HEADER", "RM_RESOURCE_SCENARIO_PROJECT_COST_REFRESH_FAILURE_DESC", "RM_RESOURCE_SCENARIO_ALLOCATION_COST_REFRESH_SUCCESS_HEADER", "RM_RESOURCE_SCENARIO_ALLOCATION_COST_REFRESH_SUCCESS_DESC", "RM_RESOURCE_SCENARIO_ALLOCATION_COST_REFRESH_FAILURE_HEADER", "RM_RESOURCE_SCENARIO_ALLOCATION_COST_REFRESH_FAILURE_DESC", "RM_RESOURCE_SCENARIO_COST_REFRESH_SUCCESS_HEADER", "RM_RESOURCE_SCENARIO_COST_REFRESH_SUCCESS_DESC", "RM_RESOURCE_DELETE_NOTIFICATION_TO_JOB_OWNER_SUCCESS_HEADER", "RM_RESOURCE_DELETE_NOTIFICATION_TO_JOB_OWNER_SUCCESS_DESC", "RM_RESOURCE_DELETE_NOTIFICATION_TO_JOB_OWNER_FAILURE_HEADER", "RM_RESOURCE_DELETE_NOTIFICATION_TO_JOB_OWNER_FAILURE_DESC", "RM_DEMAND_PROJECT_COST_REFRESH_SUCCESS_HEADER", "RM_DEMAND_PROJECT_COST_REFRESH_SUCCESS_DESC", "RM_DEMAND_PROJECT_COST_REFRESH_FAILURE_HEADER", "RM_DEMAND_PROJECT_COST_REFRESH_FAILURE_DESC", "RM_DEMAND_RESOURCE_ASSIGNMENT_FETCH_SUCCESS_HEADER", "RM_DEMAND_RESOURCE_ASSIGNMENT_FETCH_SUCCESS_DESC", "RM_DEMAND_RESOURCE_ASSIGNMENT_FETCH_FAILURE_HEADER", "RM_DEMAND_RESOURCE_ASSIGNMENT_FETCH_FAILURE_DESC", "STRATEGY_PROJECT_ALIGN_SCORE_REFRESH_SUCCESS_HEADER", "STRATEGY_PROJECT_ALIGN_SCORE_REFRESH_SUCCESS_DESC", "STRATEGY_PROJECT_ALIGN_SCORE_REFRESH_FAILURE_HEADER", "STRATEGY_PROJECT_ALIGN_SCORE_REFRESH_FAILURE_DESC", "STRATEGY_PROGRAM_ALIGN_SCORE_REFRESH_SUCCESS_HEADER", "STRATEGY_PROGRAM_ALIGN_SCORE_REFRESH_SUCCESS_DESC", "STRATEGY_PROGRAM_ALIGN_SCORE_REFRESH_FAILURE_HEADER", "STRATEGY_PROGRAM_ALIGN_SCORE_REFRESH_FAILURE_DESC", "WORKORDER_EMPTY_STATE_MESSAGE", "ADD_WBS_ASYNC_MESSAGE", "IDEA_SD_OWNER_ASSIGNED", "IDEA_MSG_OWNER_ASSIGNED", "IDEA_ACTION_SUBMITTED", "IDEA_ACTION_ASSIGNED", "IDEA_ACTION_ACCEPTED", "IDEA_ACTION_REJECTED", "IDEA_ACTION_REOPENED", "IDEA_ACTION_WITHDRAWN", "IDEA_ACTION_SET_AS_DRAFT", "IDEA_ACTION_PROPOSAL", "IDEA_SUBMITTED_HEADER", "IDEA_SUBMITTED_MESSAGE", "IDEA_ASSIGNED_HEADER", "IDEA_ASSIGNED_MESSAGE", "IDEA_ACCEPTED_HEADER", "IDEA_ACCEPTED_MESSAGE", "IDEA_REJECTED_HEADER", "IDEA_REJECTED_MESSAGE", "IDEA_REOPENED_HEADER", "IDEA_REOPENED_MESSAGE", "IDEA_WITHDRAWN_HEADER", "IDEA_WITHDRAWN_MESSAGE", "IDEA_SET_AS_DRAFT_HEADER", "IDEA_SET_AS_DRAFT_MESSAGE", "IDEA_PROPOSAL_HEADER", "IDEA_PROPOSAL_MESSAGE", "SOURCEID_EXISTS", "SUBMITTAL_REFRESH_LINK", "WORKSPACE_RESOURCE_VIEW_LINK", "PROJECT_RESOURCE_REFRESH_LINK", "PROJECT_ROLE_REFRESH_LINK", "RESOURCE_USAGE_EMPTY_STATE_MESSAGE", "ROLE_USAGE_EMPTY_STATE_MESSAGE", "RESOURCE_ROLE_USAGE_EMPTY_STATE_MESSAGE", "RESOURCE_ROLE_USAGE_SPREADSHEET_NO_DATA_AVAILABLE", "RESOURCE_USAGE_NO_VIEW_COST_PERMISSION", "ACTIVITY_USAGE_EMPTY_STATE_SPREADS_NO_ACTIVITY_MESSAGE", "ACTIVITY_USAGE_EMPTY_STATE_SPREADS_MESSAGE", "CSV_PROJECT_RESPONSE", "CSV_RESOURCE_RESPONSE", "CSV_BUDGET_ITEM_RESPONSE", "CSV_CBS_RESPONSE", "CSV_COMPANY_RESPONSE", "CSV_PROJECT_ACTUALS_RESPONSE", "CSV_PROJECT_ACTUALS_LINE_ITEM_RESPONSE", "CSV_CHANGE_ORDER_RESPONSE", "CSV_CHANGE_ORDER_LINE_ITEM_RESPONSE", "CSV_COMMITMENT_RESPONSE", "CSV_COMMITMENT_LINE_ITEM_RESPONSE", "CSV_USER_RESPONSE", "CSV_ERROR", "CSV_LABEL_FOR_REQUIRED", "CSV_LABEL", "INVESTOR_MAP_CHART_RENDER_ERROR", "PROJECT_VIEW_LINK", "DISABLE_SUBCATEGORY_MESSAGE", "ENABLE_SUBCATEGORY_MESSAGE", "PROJECT_CASHFLOW_VIEW_LINK", "PAGE_SETTINGS_REFRESH_ORIGINAL_PAGE", "PROGRAM_CASHFLOW_VIEW_LINK", "PROGRAM_VIEW_LINK", "CASHFLOW_SUB_CURVE_DISABLE_CONFIRMATION_MESSAGE", "CASHFLOW_SUB_CURVE_DISABLE_BOTH", "CASHFLOW_DISABLING_LINK_FORECAST_TO_ACTUALS_CONFIRMATION", "CASHFLOW_PROJECT_RESOURCE_COST_REFRESH_SUCCESS_HEADER", "CASHFLOW_PROJECT_RESOURCE_COST_REFRESH_SUCCESS_DESC", "CASHFLOW_PROJECT_RESOURCE_COST_REFRESH_FAILURE_HEADER", "CASHFLOW_PROJECT_RESOURCE_COST_REFRESH_FAILURE_DESC", "PROGRAM_COST_INSUFFICIENT_VIEW_PRIVILEGES", "TIMESHEET_USER_SUBMIT_INBOX_HEADER", "TIMESHEET_USER_SUBMIT_APPROVER_INBOX_DESCRIPTION", "TIMESHEET_USER_SUBMIT_SUPERVISOR_INBOX_DESCRIPTION", "TIMESHEET_SUBMIT_USER_INBOX_HEADER", "TIMESHEET_SUBMIT_USER_INBOX_DESCRIPTION", "TIMESHEET_MODIFY_SUBMIT_USER_INBOX_HEADER", "TIMESHEET_MODIFY_SUBMIT_USER_INBOX_DESCRIPTION", "TIMESHEET_SUBMIT_INBOX_HEADER", "TIMESHEET_SUBMIT_INBOX_DESCRIPTION", "TIMESHEET_MODIFY_SUBMIT_INBOX_HEADER", "TIMESHEET_MODIFY_SUBMIT_INBOX_DESCRIPTION", "TIMESHEET_APPROVE_USER_INBOX_HEADER", "TIMESHEET_APPROVE_USER_INBOX_DESCRIPTION", "TIMESHEET_APPROVE_SUPERVISOR_INBOX_HEADER", "TIMESHEET_APPROVE_SUPERVISOR_INBOX_DESCRIPTION", "TIMESHEET_REJECT_USER_INBOX_HEADER", "TIMESHEET_REJECT_USER_INBOX_DESCRIPTION", "TIMESHEET_REJECT_SUPERVISOR_INBOX_HEADER", "TIMESHEET_REJECT_SUPERVISOR_INBOX_DESCRIPTION", "TIMESHEET_REJECT_INBOX_COMMENT_SECTION", "TIMESHEET_REJECT_INBOX_NO_COMMENT", "TIMESHEET_VIEW_LINK", "TIMESHEET_WORKSPACE_SETTING_TIMEPERIODS_CREATED", "TIMESHEET_SUBMIT_CONFIRM", "TIMESHEETS_APPROVE_CONFIRM", "TIMESHEETS_REJECT_CONFIRM", "SM_SCHEDULE_BASELINE_SCENARIOS_SET_CURRENT_SCHEDULE", "EXTERNAL_EVENTS_SUBSCRIPTION_SUCCESSFUL", "EXTERNAL_EVENTS_UNSUBSCRIPTION_SUCCESSFUL", "PROGRAM_RISK_REGISTER_NO_VIEW_PRIVILEGES", "PROGRAM_EVALUATION_NO_TEMPLATE_EXISTS", "SM_SCHEDULE_COMPARISON_EMPTY_MESSAGE", "SM_SCHEDULE_COMPARISON_EMPTY_ACTIVITY_GRID_MESSAGE", "P6_XML_FAILED_ENTITY_IMPORT", "P6_XML_ENTITY_PROMOTE_FAILED_IGNORED", "P6_XML_ENTITY_PROMOTE_FAILED_IMPORT_ABORT", "P6_XML_ENTITY_PROMOTED_FROM_CHILD_WS_NO_UPDATE_REQUIRED", "P6_XML_ENTITY_PROMOTED_FROM_CHILD_WS_COPIED_PROJECT_CALENDAR", "P6_XML_ENTITY_PROMOTED_FROM_CHILD_WS_ENTITY_UPDATED", "P6_XML_ENTITY_FOUND_ADDED_TO_CURRENT_WS_NO_UPDATE", "P6_XML_ENTITY_FOUND_ADDED_TO_CURRENT_WS_CANNOT_UPDATE", "P6_XML_ENTITY_NOT_FOUND_CANNOT_CREATE_IN_CURRENT_WORKSPACE", "P6_XML_ENTITY_NOT_FOUND_CREATED_NEW", "P6_XML_ENTITY_CREATED_NEW", "P6_XML_WBS_SUMMARY_ACTIVITY", "P6_XML_PROJECT_WBS_ASSIGNMENT", "P6_XML_ENTITY_FOUND_INSERT_NEW_OPTION_CREATED_NEW", "P6_XML_MULTIPLE_entity_FOUND_NEW_ENTITY_CREATED", "P6_XML_ENTITY_FOUND_IGNORE_CONFIGURED_USED_EXISTING", "P6_XML_ENTITY_FOUND_UPDATE_BASELINE_CONFIGURED_USED_EXISTING", "P6_XML_ENTITY_UPDATE_BASELINE_CONFIGURED_USED_EXISTING_PROJECT", "P6_XML_ENTITY_NOT_FOUND_UPDATE_BASELINE_CONFIGURED_IGNORED", "P6_XML_ENTITY_NOT_FOUND_IGNORE_CONFIGURED_IGNORED", "P6_XML_ENTITY_HAS_ENTITY_AS_IGNORED_CONFIGURED_IGNORED", "P6_XML_ENTITY_HAS_ENTITY_AS_IGNORED_ON_IMPORT_CONFIGURED_IGNORED", "P6_XML_ENTITY_HAS_ENTITY_AS_UPDATE_BASELINE_ONLY_CONFIGURED_IGNORED", "P6_XML_ENTITY_FOUND_UPDATE_EXISTING_UPDATED", "P6_XML_ENTITY_UPDATE_EXISTING_UPDATED", "P6_XML_ENTITY_IMPORT_FAIL", "P6_XML_ENTITY_FOUND_KEEP_EXISTING_CONFIGURED_USED_EXISTING", "P6_XML_ENTITY_NOT_FOUND_IGNORE_CONFIGURED_USED", "P6_XML_ENTITY_REMOVED_FROM_PRIME", "P6_XML_ENTITY_RESOURCE_ROLE_IGNORED_ASSIGNMENT_IGNORED", "P6_XML_ENTITY_RISK_SCORE_TYPE_IGNORED_RISK_IGNORED", "P6_XML_ENTITY_RISK_IGNORED_RISK_MITIGATION_IGNORED", "P6_XML_ACTIVITY_DEPENDENT_IGNORED", "P6_XML_ENTITY_RISK_SCORE_TYPE_IGNORED_RISKMATRIX_IGNORED", "P6_XML_ENTITY_RISK_MATRIX_IGNORED_RISK_IGNORED", "P6_XML_ACTIVITY_WBS_SCOPE_RULE_IGNORED", "P6_XML_DUPLICATE_RELATIONSHIP", "P6_XML_ACTIVITY_MILESTONE_ASSG_RULE_IGNORED", "P6_XML_ENTITY_CURVE_IGNORED", "P6_XML_ENTITY_ACTUAL_CURVE_IGNORED", "P6_XML_ENTITY_FOUND_HIERARCHY_EXIST_NOT_IMPORTED", "P6_XML_ENTITY_ACTIVITY_TYPE_MILESTONE", "P6_XML_ENTITY_ASSIGNMENT_TYPE_DEFAULT", "P6_XML_ENTITY_ASSIGNMENT_DUPLICATE", "P6_XML_ENTITY_ASSIGNMENT_RESOURCEROLE_NOT_FOUND", "P6_XML_ENTITY_ASSIGNMENT_RESOURCE_ROLE_ACTUAL_UNIT_EXIST", "P6_XML_ENTITY_NOT_REMOVED_TIMESHEET_HOURS_APPROVED", "P6_XML_UOM_NOT_IMPORTED", "P6_XML_ENTITY_FOUND_NOT_IMPORT_TYPE_MISMATCH", "P6_XML_IMPORT_FAILED_CONSTRAINT_CONFLICT", "P6_XML_IMPORT_FAILED_EXCEPTION_CONFLICT", "P6_XML_RESOURCE_FOUND_NO_ASSIGNMENT", "P6_XML_RESOURCE_TYPE_MISMATCH", "P6_XML_PRIMAVERA_CLOUD_BASELINE_EXISTS_IGNORED", "P6_XML_CANNOT_UPDATE_FORMULA_UDF", "P6_XML_ENTITY_FOUND_AFTER_TRUNCATE", "P6_XML_DUPLICATE_ROLE_ID_PRESENT", "P6_XML_DUPLICATE_UDF_PRESENT", "P6_XML_EMPTY_UDF_LABEL", "P6_XML_CREATE_NEW_IMPORT_OPTION", "P6_XML_UPDATE_EXISTING_IMPORT_OPTION", "P6_XML_KEEP_EXISTING_IMPORT_OPTION", "P6_XML_IGNORE_IMPORT_OPTION", "P6_XML_IMPORT_PROJECT_AND_WBS_NOTES", "P6_XML_UPDATE_BASELINE_SCENARIO_ONLY_IMPORT_OPTION", "P6_XML_BASELINE_SCENARIO_ENTITY_IGNORE_CONFIGURED", "P6_XML_ENTITY_IGNORED", "ACTIVITY_RENUMBER_FAILED", "ACTIVITY_RENUMBER_SUCCESSFUL", "ACTIVITY_RENUMBER_FAIL_DESCRIPTION", "ACTIVITY_RENUMBER_SUCCESS_DESCRIPTION", "ACTIVITY_RENUMBER_NO_PROJECT_PRIVILEGE", "ACTIVITY_RENUMBER_NO_ACTIVITY_EDIT_PRIVILEGE", "ACTIVITY_RENUMBER_NO_BASELINE_ACTIVITY_EDIT_PRIVILEGE", "UDF_DEL_INVALID_LABEL", "UDF_DEL_INVALID_NAME", "UDF_DEL_INVALID_ID", "UDF_DEL_INVALID_ASSIGNMENT_ID", "INVALID_CHILD_DEL", "EXCEL_IMPORT_SUCCES_CUSTOM_LOG", "EXCEL_IMPORT_FAILED_CUSTOM_LOG", "EXCEL_IMPORT_TERMINATED_CUSTOM_LOG", "PORTFOLIO_PRIORITIZATION_MATRIX_VIEW_LINK", "BUDGET_TRANSACTION_DEL_INVALID_TRANSACTION_ID", "PROJECT_CALENDAR_DELETE", "SCORECARD_VIEW_LINK", "THRESHOLD_SUB_CAT_PROMPT_BOX_TITLE", "THRESHOLD_SUB_CAT_PROMPT_BOX_MSG", "MOVE_LOG_BASELINE_CATEGORY_ENTITY", "MOVE_LOG_CALENDAR_ENTITY", "MOVE_LOG_CODE_ENTITY", "MOVE_LOG_NOTEBOOK_ENTITY", "MOVE_LOG_CURVE_ENTITY", "MOVE_LOG_PERMISSION_ENTITY", "MOVE_LOG_REASON_ENTITY", "MOVE_LOG_FLEX_FIELD_ENTITY", "MOVE_LOG_COLUMN_DEFINITION_FIELD_RELATIONSHIP_ENTITY", "MOVE_LOG_REPORT_ENTITY", "MOVE_LOG_RESOURCE_ENTITY", "MOVE_LOG_PROJECTRESOURCE_ENTITY", "MOVE_LOG_ROLE_ENTITY", "MOVE_LOG_PROJECTROLE_ENTITY", "MOVE_LOG_COST_CATEGORY_ENTITY", "MOVE_LOG_WORKFLOW_ENTITY", "MOVE_INACCESSIBLE_WORKFLOW", "MOVE_INACCESSIBLE_RUNNING_WORKFLOW", "MOVE_LOG_CUSTOM_LOG_ENTITY", "MOVE_LOG_PROJECT_CUSTOM_LOG_ENTITY", "MOVE_LOG_RULE_OF_CREDIT_ENTITY", "MOVE_LOG_UNITS_OF_MEASURE_ENTITY", "MOVE_LOG_CURRENCY_ENTITY", "MOVE_LOG_FORMS_ENTITY", "MOVE_LOG_EVALUATION_MATRIX_ENTITY", "MOVE_LOG_PROGRAM_ENTITY", "MOVE_LOG_INSIGHT_MODEL_ENTITY", "MOVE_LOG_CBSSHEET_CODE_ENTITY", "MOVE_LOG_CBS_ENTITY", "MOVE_LOG_DASHBOARD_ENTITY", "MOVE_LOG_REPORT_CYCLE_ENTITY", "MOVE_LOG_PRINTLAYOUT_ENTITY", "MOVE_LOG_PROJ_USER_GROUP_ENTITY", "MOVE_LOG_WS_USER_GROUP_ENTITY", "MOVE_LOG_PROJECT_DASHBOARD_ENTITY", "MOVE_LOG_BASELINE_CATEGORY", "MOVE_LOG_CALENDAR", "MOVE_LOG_CODE", "MOVE_LOG_NOTEBOOK_TOPIC", "MOVE_LOG_CURVE", "MOVE_LOG_PERMISSION", "MOVE_LOG_REASON", "MOVE_LOG_FLEX_FIELD", "MOVE_LOG_REPORT", "MOVE_LOG_PRINTLAYOUT", "MOVE_LOG_RESOURCE", "MOVE_LOG_PROJECTRESOURCE", "MOVE_LOG_PROJECTRESOURCE_LOWER_CASE", "MOVE_LOG_PROJECTROLE_LOWER_CASE", "MOVE_LOG_ROLE", "MOVE_LOG_PROJECTROLE", "MOVE_LOG_COST_CATEGORY", "MOVE_LOG_COST_CATEGORY_LOWER_CASE", "MOVE_LOG_CUSTOM_LOG", "MOVE_LOG_UNITS_OF_MEASURE", "MOVE_LOG_CURRENCY", "MOVE_LOG_RULE_OF_CREDIT", "MOVE_LOG_RULE_OF_CREDIT_LOWER_CASE", "MOVE_LOG_EVALUATION_MATRIX", "MOVE_LOG_PROGRAM", "MOVE_LOG_INSIGHT_MODEL", "MOVE_LOG_CBSSHEET_CODE", "MOVE_LOG_DASHBOARD", "MOVE_LOG_REPORT_CYCLE", "MOVE_LOG_USER_GROUP", "MOVE_LOG_PROJECT_DASHBOARD", "MOVE_LOG_PROJECT_DASHBOARD_LOWER_CASE", "MOVE_LOG_WORKFLOW", "MOVE_WORKSPACE_LOG_REPORT_ENTITY", "MOVE_WORKSPACE_OWNED_ENTITY", "MOVE_WORKSPACE_INHERITED_ENTITY", "MOVE_PROJECT_SHARED_ENTITY_PULLED_DOWN", "MOVE_PROJECT_SHARED_ENTITY_PROMOTED", "MOVE_PROJECT_SHARED_ENTITY_PROMOTED_AND_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_PROMOTED_ID_NAME_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_ONLY_PROMOTED", "MOVE_PROJECT_SHARED_ENTITY_ONLY_PROMOTED_AND_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_ONLY_PROMOTED_ID_NAME_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_NOT_UPDATED", "MOVE_PROJECT_SHARED_ENTITY_REMOVED", "MOVE_PROJECT_SHARED_ENTITY_COPIED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_RES_ROLE_IGNORED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_AND_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_AND_RENAMED_RES_ROLE_IGNORED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_ID_NAME_RENAMED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_ID_NAME_RENAMED_RES_ROLE_IGNORED", "MOVE_PROJECT_SHARED_ENTITY_COPIED_ID_NAME_RENAMED_EXISTING_UDF_COPIED", "MOVE_PROJECT_RESTRICTED_ENTITY_ASSOCIATED", "MOVE_PROJECT_CUSTOM_LOG_RESTRICTED_ENTITY_ASSOCIATED", "MOVE_PROJECT_RESOURCE_ID_RENAMED", "MOVE_PROJECT_ROLE_ID_RENAMED", "MOVE_PROJECT_REPORT_MOVED", "MOVE_PROJECT_REPORT_ID_RENAMED", "MOVE_PROJECT_EVALUATION_CATEGORY_REMOVED", "MOVE_PROJECT_WS_USER_GROUP_REMOVED", "MOVE_PROJECT_PROJ_USER_GROUP_REMOVED", "MOVE_PROJECT_USER_GROUP_UNCHANGED", "MOVE_PROJECT_PROJ_CUSTOM_LOG_RENAMED", "MOVE_PROJECT_PRINTLAYOUT_UNCHANGED", "MOVE_PROJECT_PROJECT_REMOVED_FROM_PROGRAM", "MOVE_PROJECT_CBS_CODE_COPIED_TO_PROJECT", "MOVE_PROJECT_SUCCESS", "MOVE_PROJECT_FAIL", "PROJECT_MOVE_FAILED_EXCEPTION_CONFLICT", "PROJECT_MOVE_FAILED_CONSTRAINT_CONFLICT", "PROJECT_MOVE_FAILED", "PROJECT_MOVE_FAILED_SUMMARY", "WORKSPACE_COUNT_MOVED", "PROJECT_COUNT_MOVED", "FUND_COUNT_MOVED", "PORTFOLIO_COUNT_MOVED", "SAME_FORMULA_UDF_IS_EXISTING", "ANALYSIS_VIEW_COUNT_MOVED", "IDEA_COUNT_MOVED", "IDEA_COUNT_RENAMED", "CALENDAR_COUNT_MOVED", "CALENDAR_COUNT_COPIED", "CALENDAR_COUNT_UNCHANGED", "CALENDAR_MOVE_COUNT_FAILED", "CALENDAR_COUNT_AUTOMATICALLY_HANDLED", "CALENDAR_COUNT_RENAMED", "COST_CATEGORY_COUNT_FAILED", "COST_CATEGORY_COUNT_UNCHANGED", "COST_CATEGORY_COUNT_MOVED", "COST_CATEGORY_COUNT_COPIED", "COST_CATEGORY_COUNT_AUTOMATICALLY_HANDLED", "WORKFLOW_COUNT_FAILED", "WORKFLOW_COUNT_UNCHANGED", "WORKFLOW_COUNT_MOVED", "WORKFLOW_COUNT_COPIED", "WORKFLOW_COUNT_AUTOMATICALLY_HANDLED", "CUSTOM_LOG_COUNT_FAILED", "CUSTOM_LOG_COUNT_UNCHANGED", "CUSTOM_LOG_COUNT_MOVED", "CUSTOM_LOG_COUNT_COPIED", "CUSTOM_LOG_COUNT_AUTOMATICALLY_HANDLED", "PROJECT_CUSTOM_LOG_COUNT_MOVED", "PROJECT_CUSTOM_LOG_COUNT_COPIED", "PROJECT_CUSTOM_LOG_COUNT_UNCHANGED", "PROJECT_CUSTOM_LOG_COUNT_AUTOMATICALLY_HANDLED", "RULE_OF_CREDIT_COUNT_FAILED", "RULE_OF_CREDIT_COUNT_UNCHANGED", "RULE_OF_CREDIT_COUNT_MOVED", "RULE_OF_CREDIT_COUNT_RENAMED", "RULE_OF_CREDIT_COUNT_REMOVED", "RULE_OF_CREDIT_COUNT_COPIED", "RULE_OF_CREDIT_COUNT_AUTOMATICALLY_HANDLED", "CODE_COUNT_MOVED", "CODE_COUNT_COPIED", "CODE_COUNT_UNCHANGED", "CODE_COUNT_MOVE_FAILED", "CODE_COUNT_AUTOMATICALLY_HANDLED", "NOTEBOOK_COUNT_MOVED", "NOTEBOOK_COUNT_COPIED", "NOTEBOOK_COUNT_UNCHANGED", "NOTEBOOK_COUNT_MOVE_FAILED", "NOTEBOOK_COUNT_AUTOMATICALLY_HANDLED", "FOLDER_TEMPLATE_COUNT_MOVED", "FOLDER_TEMPLATE_COUNT_RENAMED", "FOLDER_TEMPLATE_COUNT_REMOVED", "FLEX_FIELD_COUNT_MOVED", "FLEX_FIELD_COUNT_COPIED", "FLEX_FIELD_COUNT_UNCHANGED", "FLEX_FIELD_COUNT_AUTOMATICALLY_HANDLED", "FLEX_FIELD_MOVE_COUNT_FAILED", "PERMISSION_COUNT_MOVED", "PERMISSION_COUNT_COPIED", "PERMISSION_COUNT_UNCHANGED", "PERMISSION_COUNT_MOVE_FAILED", "PERMISSION_COUNT_AUTOMATICALLY_HANDLED", "REPORT_COUNT_MOVED", "REPORT_COUNT_COPIED", "REPORT_COUNT_UNCHANGED", "REPORT_COUNT_AUTOMATICALLY_HANDLED", "REPORT_COUNT_MOVE_FAILED", "WS_RESOURCE_COUNT_MOVED", "WS_RESOURCE_COUNT_RENAMED", "WS_RESOURCE_COUNT_COPIED", "WS_RESOURCE_COUNT_UNCHANGED", "WS_RESOURCE_COUNT_MOVE_FAILED", "WS_RESOURCE_COUNT_AUTOMATICALLY_HANDLED", "WSMOVE_RESOURCE_COUNT_MOVED", "WSMOVE_RESOURCE_COUNT_RENAMED", "PR_RESOURCE_COUNT_MOVED", "PR_RESOURCE_COUNT_COPIED", "PR_RESOURCE_COUNT_UNCHANGED", "PR_RESOURCE_COUNT_AUTOMATICALLY_HANDLED", "PR_RESOURCE_COUNT_MOVE_FAILED", "WS_ROLE_COUNT_MOVED", "WS_ROLE_COUNT_RENAMED", "WS_ROLE_COUNT_COPIED", "WS_ROLE_COUNT_UNCHANGED", "WS_ROLE_COUNT_MOVE_FAILED", "WS_ROLE_COUNT_AUTOMATICALLY_HANDLED", "WSMOVE_ROLE_COUNT_MOVED", "WSMOVE_ROLE_COUNT_RENAMED", "WSMOVE_ROLE_COUNT_REMOVED", "PR_ROLE_COUNT_MOVED", "PR_ROLE_COUNT_COPIED", "PR_ROLE_COUNT_UNCHANGED", "PR_ROLE_COUNT_AUTOMATICALLY_HANDLED", "PR_ROLE_COUNT_MOVE_FAILED", "CURVE_COUNT_MOVED", "CURVE_COUNT_COPIED", "CURVE_COUNT_UNCHANGED", "CURVE_COUNT_MOVE_FAILED", "CURVE_COUNT_AUTOMATICALLY_HANDLED", "REASON_COUNT_MOVED", "REASON_COUNT_COPIED", "REASON_COUNT_UNCHANGED", "REASON_COUNT_MOVE_FAILED", "REASON_COUNT_AUTOMATICALLY_HANDLED", "MEASURE_COUNT_MOVED", "UNITS_OF_MEASURE_COUNT_MOVED", "UNITS_OF_MEASURE_COUNT_COPIED", "UNITS_OF_MEASURE_COUNT_UNCHANGED", "UNITS_OF_MEASURE_COUNT_FAILED", "UNITS_OF_MEASURE_COUNT_AUTOMATICALLY_HANDLED", "UNITS_OF_MEASURE_COUNT_RENAMED", "UNITS_OF_MEASURE_COUNT_REMOVED", "INSIGHT_MODEL_COUNT_MOVED", "INSIGHT_MODEL_COUNT_COPIED", "INSIGHT_MODEL_COUNT_UNCHANGED", "INSIGHT_MODEL_MOVE_COUNT_FAILED", "INSIGHT_MODEL_COUNT_AUTOMATICALLY_HANDLED", "DASHBOARD_COUNT_MOVED", "DASHBOARD_COUNT_COPIED", "DASHBOARD_COUNT_UNCHANGED", "DASHBOARD_MOVE_COUNT_FAILED", "DASHBOARD_COUNT_AUTOMATICALLY_HANDLED", "PS_DASHBOARD_COUNT_MOVED", "PS_DASHBOARD_COUNT_COPIED", "PS_DASHBOARD_COUNT_UNCHANGED", "PS_DASHBOARD_COUNT_AUTOMATICALLY_HANDLED", "MOVE_PROJECT_DASHBOARD_ID_RENAMED", "DASHBOARD_ONLY_COUNT_MOVED", "REPORT_CYCLE_COUNT_RENAMED", "REPORT_CYCLE_COUNT_MOVED", "REPORT_CYCLE_COUNT_COPIED", "REPORT_CYCLE_COUNT_UNCHANGED", "REPORT_CYCLE_MOVE_COUNT_FAILED", "REPORT_CYCLE_COUNT_AUTOMATICALLY_HANDLED", "CURRENCY_COUNT_MOVED", "CURRENCY_COUNT_COPIED", "CURRENCY_COUNT_AUTOMATICALLY_HANDLED", "CURRENCY_COUNT_UNCHANGED", "EVALUATION_MATRIX_COUNT_REMOVED", "EVALUATION_MATRIX_COUNT_RENAMED", "EVALUATION_MATRIX_NO_TEMPLATE_EXISTS", "EVALUATION_MATRIX_ACTIVATE_INFO_BANNER", "EVALUATION_MATRIX_COUNT_MOVED", "EVALUATION_MATRIX_COUNT_COPIED", "EVALUATION_MATRIX_COUNT_AUTOMATICALLY_HANDLED", "EVALUATION_MATRIX_COUNT_UNCHANGED", "DECREASED_RANK_SCALE_DIALOG_TEXT", "PROGRAM_COUNT_RENAMED", "PROGRAM_COUNT_MOVED", "PROGRAM_COUNT_COPIED", "PROGRAM_COUNT_UNCHANGED", "PROGRAM_COUNT_AUTOMATICALLY_HANDLED", "PROGRAM_COUNT_MOVE_FAILED", "WS_USER_GROUP_COUNT_MOVED", "WS_USER_GROUP_COUNT_COPIED", "WS_USER_GROUP_COUNT_AUTOMATICALLY_HANDLED", "WS_USER_GROUP_COUNT_UNCHANGED", "PROJ_USER_GROUP_COUNT_MOVED", "PROJ_USER_GROUP_COUNT_COPIED", "PROJ_USER_GROUP_COUNT_UNCHANGED", "PROJ_USER_GROUP_COUNT_AUTOMATICALLY_HANDLED", "VIEW_COUNT_MOVED", "VIEW_COUNT_RENAMED", "FILTER_COUNT_MOVED", "FILTER_COUNT_RENAMED", "STRATEGY_COUNT_MOVED", "CBS_COUNT_REMOVED", "CBS_COUNT_RENAMED", "CBS_COUNT_MOVED", "CBSSHEET_CODE_COUNT_MOVED", "CBSSHEET_CODE_COUNT_COPIED", "CBSSHEET_CODE_COUNT_UNCHANGED", "CBSSHEET_CODE_COUNT_AUTOMATICALLY_HANDLED", "CURRENCY_RECALCULATION_SUCCESS_TITLE", "CURRENCY_RECALCULATION_SUCCESS_DESCRIPTION", "CURRENCY_RECALCULATION_FAIL_TITLE", "CURRENCY_RECALCULATION_FAIL_DESCRIPTION", "CURRENCY_RECALCULATION_INPROGRESS_TITLE", "CURRENCY_RECALCULATION_INPROGRESS_DESCRIPTION", "CURRENCY_RECALCULATION_UPDATE_FAILED", "PRINTLAYOUT_COUNT_MOVED", "PRINTLAYOUT_COUNT_COPIED", "PRINTLAYOUT_COUNT_UNCHANGED", "PRINTLAYOUT_COUNT_AUTOMATICALLY_HANDLED", "PRINTLAYOUT_REMOVED", "WORKSPACE_MOVE_RISK_MATRIX_COUNT_MOVED", "WORKSPACE_MOVE_RISK_MATRIX_COUNT_RENAMED", "WORKSPACE_MOVE_RISK_SCORE_TYPE_COUNT_MOVED", "WORKSPACE_MOVE_RISK_SCORE_TYPE_COUNT_RENAMED", "BASELINE_CATEGORY_COUNT_MOVED", "BASELINE_CATEGORY_COUNT_COPIED", "BASELINE_CATEGORY_COUNT_UNCHANGED", "BASELINE_CATEGORY_COUNT_AUTOMATICALLY_HANDLED", "BASELINE_CATEGORY_COUNT_FAILED", "API_ACCESS_RESTRICTED", "API_DUPLICATE_RECORDS_FOUND_CHECK_CHILD_RESPONSES", "API_MULTIPLE_NESTED_ENTITES_FOR_SAME_DB_ENTRY_SENT", "API_PROJECT_RISK_SCORE_TYPE_THRESHOLDS_COUNT_CHANGE_NOT_MODIFIED", "API_RISK_ANALYSIS_ALREADY_IN_PROGRESS_CANNOT_TRIGGER_NEW_RUN", "API_RISK_MATRIX_SCORE_NOT_FOUND_TO_DELETE", "API_RISK_MATRIX_SCORE_TYPE_NOT_FOUND_TO_DELETE", "API_RISK_MATRIX_TOLERANCE_NOT_FOUND_TO_DELETE", "API_RISK_REQUIRED_FIELD", "API_RISK_SCORE_THRESHOLD_NOT_FOUND_TO_DELETE", "API_RULE_OF_CREDIT_MILESTONE_NOT_FOUND_TO_DELETE", "API_WBS_IMPORT_RUNNING_IN_BACKGROUND", "API_UNSUPPORTED_PROJECTION_FORMAT_SPECIFIED", "INVALID_USER_PAYLOAD", "USER_NOT_PRESENT_IN_USERGROUP_OR_INHERITED", "USER_ALREADY_PRESENT", "INVALID_CUSTOMLOG_USER", "MISSING_MANDATORY_PERMISSIONSET", "INVALID_PROJECT_PERMISSIONSET", "INVALID_CUSTOMLOG_PERMISSIONSET", "INVALID_DOCUMENT_PERMISSIONSET", "INVALID_REPORT_PERMISSIONSET", "INVALID_WORKSPACE_PERMISSIONSET", "INVALID_PROGRAM_PERMISSIONSET", "INVALID_PORTFOLIO_PERMISSIONSET", "INVALID_IDEA_PERMISSIONSET", "INVALID_GLOBAL_PERMISSIONSET", "INVALID_GLOBAL_PERMISSIONSET_ASSIGNMENT", "INVALID_ENTITY_SCOPE", "VALID_ASSIGNMENT", "INVALID_UG_PAYLOAD", "UG_INVALID_PROJECT_PERMISSIONSET", "UG_INVALID_CUSTOMLOG_PERMISSIONSET", "UG_INVALID_DOCUMENT_PERMISSIONSET", "UG_INVALID_REPORT_PERMISSIONSET", "UG_INVALID_WORKSPACE_PERMISSIONSET", "UG_INVALID_PROGRAM_PERMISSIONSET", "UG_INVALID_PORTFOLIO_PERMISSIONSET", "UG_INVALID_IDEA_PERMISSIONSET", "USAGE_IN_USER_GROUP", "RESET_ALL_USERS", "REMOVE_USERS_API_GATEWAY_ACCESS", "SAVE_NO_USERS", "API_USER_ACCESS_REMOVE_MESSAGE", "RESET_ALL_ADDRESSES", "API_IP_ACCESS_REMOVE_MESSAGE", "REMOVE_COMBINED_API_GATEWAY_ACCESS", "EXPORT_ENTIRE_SPREAD_EXPORT_SUCCESS", "EXPORT_ENTIRE_SPREAD_EXPORT_FAIL", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_SUCCESS_PROJECT", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_FAIL_PROJECT", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_SUCCESS_PROGRAM", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_FAIL_PROGRAM", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_SUCCESS_WORKSPACE", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_SUCCESS_MULTIPLE_PROJECTS", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_FAIL_WORKSPACE", "EXPORT_ENTIRE_SPREAD_EXPORT_DETAIL_FAIL_MULTIPLE_PROJECTS", "PROJECT_MIGRATION_FAILED", "PROJECT_MIGRATION_SUMMARY", "MIGRATION_COUNT_FAILED", "DELETE_WBS_CONFIRMATION_MESSAGE", "DELETE_WBS_REASSIGN_ASSOCIATED_ACTIVITIES_TASKS", "OIC_CONNECTION_LOAD_FAIL" ] }, "taskId":{ "type":"integer", "description":"Unique identifier of the task associated with the step the workflow is on.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "stepId":{ "type":"integer", "description":"Unique identifier of the step the workflow is on.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityStartWorkflowInstance":{ "title":"ApiEntityStartWorkflowInstance", "type":"object", "properties":{ "name":{ "maxLength":255, "type":"string", "description":"The user specified identifier of the workflow instance.", "exampleSetFlag":false, "types":[ "string" ] }, "instanceId":{ "type":"integer", "description":"System generated unique identifier of the workflow instance.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workflowConfigVersionId":{ "type":"integer", "description":"The system generated identifier of a workflow configuration.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "instantiationType":{ "type":"string", "description":"Specifies the instantiated type of triggering the workflow.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "BY_PARENTWF_INSTANCE", "BY_USER", "PROJECT_PROPOSAL", "SCN_STATUS_CHANGED", "BY_EVENT", "BY_API" ] }, "startDate":{ "type":"string", "description":"The date and time the workflow instance started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"The status of the workflow instance. A workflow instance can have a status of In Progress, Finished, Overdue, Failed, Pending, or Stopped.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EXECUTING", "FINISHED", "HALTED", "PENDING", "STOPPED" ] } }, "exampleSetFlag":false }, "ApiEntityStartWorkflowResponse":{ "title":"ApiEntityStartWorkflowResponse", "type":"object", "properties":{ "preExecutionValidationProblems":{ "type":"array", "description":"Specifies the validation problems in starting a workflow.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityPreExecutionValidationProblem", "exampleSetFlag":false }, "types":[ "array" ] }, "workflowInstanceModel":{ "description":"Specifies the instance used to start a workflow.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityStartWorkflowInstance" } ] }, "startWorkflowResult":{ "type":"string", "description":"Specifies the result after starting a workflow.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OK", "HAS_VALIDATION_ERRORS", "HAS_PRE_EXECUTION_VALIDATION_ERRORS", "CONTEXT_NOT_DEFINED" ] } }, "exampleSetFlag":false }, "ApiEntityStartWorkflow":{ "title":"ApiEntityStartWorkflow", "required":[ "dueDate", "useDefaultScope", "workflowConfigName", "workflowInstanceName", "workspaceId" ], "type":"object", "properties":{ "duration":{ "type":"number", "description":"Specifies the days beyond which workflow instance will be set to overdue.", "format":"double", "exampleSetFlag":false }, "workflowConfigVersionId":{ "type":"integer", "description":"The system generated identifier of a workflow configuration.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workflowInstanceName":{ "maxLength":255, "type":"string", "description":"The user specified identifier of the workflow instance.", "exampleSetFlag":false, "types":[ "string" ] }, "useDefaultScope":{ "type":"boolean", "description":"Allows to assign scope set in workflow configuration.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workflowConfigName":{ "maxLength":255, "type":"string", "description":"The name of the workflow configuration.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The code of a workspace associated to a workflow.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "description":"Allows to assign scope while starting a workflow.If useDefaultScope is set to false, workflow scope details are fetched from this entity.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityWorkflowInstanceScope" } ] }, "dueDate":{ "type":"string", "description":"Specifies the date beyond which workflow instance will be set to overdue.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkflowInstanceScope":{ "title":"ApiEntityWorkflowInstanceScope", "required":[ "objectId", "objectType" ], "type":"object", "properties":{ "objectType":{ "type":"string", "description":"Specifies the type of object for the workflow to be triggered.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROJECT", "RISK" ] }, "overlayId":{ "type":"integer", "description":"System generated unique identifier of a scenario, only used in the context of portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "objectId":{ "type":"integer", "description":"The unique identifier of the object for which the workflow is to be triggered.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scenarioName":{ "maxLength":255, "type":"string", "description":"Specifies the scenario name under a capital plan.", "exampleSetFlag":false, "types":[ "string" ] }, "planPeriod":{ "type":"integer", "description":"Specifies the planned period for a portfolio.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityWorkflowInstance":{ "title":"ApiEntityWorkflowInstance", "type":"object", "properties":{ "context":{ "maxLength":0, "type":"string", "description":"The specific object that the workflow runs against.", "exampleSetFlag":false, "types":[ "string" ] }, "workflowConfigurationName":{ "maxLength":255, "type":"string", "description":"The name of the workflow configuration. Task performers and workflow managers identify running workflows by the names of their configurations.", "exampleSetFlag":false, "types":[ "string" ] }, "workflowInstanceId":{ "type":"integer", "description":"System generated unique identifier of the workflow instance.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "startedDate":{ "type":"string", "description":"The date and time the workflow instance started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "startedBy":{ "maxLength":0, "type":"string", "description":"The user who started the workflow instance.", "exampleSetFlag":false, "types":[ "string" ] }, "configurationVersion":{ "type":"integer", "description":"Version of the workflow configuration that was used to create the workflow instance.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "contextType":{ "type":"string", "description":"The kind of object that the workflow runs against or displays information about.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "APPLICATION_USER", "CAPITAL_PLAN", "CAPITAL_PLAN_PROJECT", "CAPITAL_PORTFOLIO", "COLUMN_DEFINTION", "NONE", "PROJECT", "PROJECT_CATEGORY_VALUE", "SEC_ROLE", "WORKFLOW_CONFIG", "WORKSPACE", "CONTRACT", "COMMITMENT", "RISK", "RISK_PROG", "SUBMITTAL", "CHANGEORDER", "BUDGET", "BUDGET_CHANGE", "BUDGET_TRANSFER", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGE", "PROGRAM_BUDGET_TRANSFER", "RFI", "IDEA", "PROGRAM", "POTENTIAL_CHANGE_ORDER", "CHANGE_EVENTS" ] }, "managers":{ "type":"array", "description":"User/s who were assigned to manage the workflow instance.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "workflowInstanceName":{ "maxLength":255, "type":"string", "description":"Name of the workflow instance within which the task is configured.", "exampleSetFlag":false, "types":[ "string" ] }, "plannedDuration":{ "type":"number", "description":"Duration in days that was planned for the workflow instance to be completed. Post this duration the workflow instance will be marked as overdue.", "format":"double", "exampleSetFlag":false }, "workspaceName":{ "maxLength":255, "type":"string", "description":"Name of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "actualDuration":{ "type":"number", "description":"Actual Duration in days taken by the Workflow Instance to reach state of termination i.e status which is completed/stopped/failed.", "format":"double", "exampleSetFlag":false }, "status":{ "type":"string", "description":"The status of the workflow instance. A workflow instance can have a status of In Progress, Finished, Overdue, Failed, Pending, or Stopped.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EXECUTING", "FINISHED", "HALTED", "PENDING", "STOPPED" ] }, "dueDate":{ "type":"string", "description":"The date by which the workflow should be completed. If a workflow is not completed by its due date, then the system notifies the workflow manager and marks the workflow as overdue", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityStepInstance":{ "title":"ApiEntityStepInstance", "type":"object", "properties":{ "context":{ "maxLength":0, "type":"string", "description":"Name of the context object on which the step is executed.", "exampleSetFlag":false, "types":[ "string" ] }, "workflowInstanceId":{ "type":"integer", "description":"System generated unique identifier of the workflow instance.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "startedDate":{ "type":"string", "description":"Date & Time of when the step was started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "tasksCompleted":{ "type":"integer", "description":"Count of number of tasks within the step that have been completed.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workflowInstanceName":{ "maxLength":255, "type":"string", "description":"Name of the workflow instance within which the task is configured.", "exampleSetFlag":false, "types":[ "string" ] }, "stepName":{ "maxLength":255, "type":"string", "description":"Name of the step within which the task is configured.", "exampleSetFlag":false, "types":[ "string" ] }, "completedDate":{ "type":"string", "description":"Date & Time of when the step was completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"Current Status of the Step.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EXECUTING", "FINISHED", "WITHDRAWN", "SKIPPED" ] } }, "exampleSetFlag":false }, "ApiEntityTaskInstance":{ "title":"ApiEntityTaskInstance", "type":"object", "properties":{ "context":{ "maxLength":0, "type":"string", "description":"Name of the context object on which the task is executed.", "exampleSetFlag":false, "types":[ "string" ] }, "workflowInstanceId":{ "type":"integer", "description":"System generated unique identifier of the workflow instance.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "startedDate":{ "type":"string", "description":"Date & Time of when the task was started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "completionPolicy":{ "type":"string", "description":"Completion policy set for the task.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ALL", "ANY", "MAJORITY" ] }, "formName":{ "type":"string", "description":"Applicable only for form tasks. Name of the form which is associated with the task.", "exampleSetFlag":false, "types":[ "string" ] }, "formVersion":{ "type":"integer", "description":"Applicable only for form tasks. Version of the form which is associated with the task.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "performers":{ "type":"array", "description":"List of performers that have been assigned to the task.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityTaskPerformer", "exampleSetFlag":false }, "types":[ "array" ] }, "workflowInstanceName":{ "maxLength":255, "type":"string", "description":"Name of the workflow instance within which the task is configured.", "exampleSetFlag":false, "types":[ "string" ] }, "stepName":{ "maxLength":255, "type":"string", "description":"Name of the step within which the task is configured.", "exampleSetFlag":false, "types":[ "string" ] }, "taskType":{ "maxLength":60, "type":"string", "description":"Type of task.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "Form", "Sub-workflow", "Portfolio Refresh", "Update Field", "Services", "Decision" ] }, "taskName":{ "maxLength":255, "type":"string", "description":"Name of the task.", "exampleSetFlag":false, "types":[ "string" ] }, "completedDate":{ "type":"string", "description":"Date & Time of when the task was started.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"Current Status of the task.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EXECUTING", "FINISHED", "FAILED", "SKIPPED" ] } }, "exampleSetFlag":false }, "ApiEntityTaskPerformer":{ "title":"ApiEntityTaskPerformer", "type":"object", "properties":{ "dateCompleted":{ "type":"string", "description":"The date and time when the performer completed the task.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":0, "type":"string", "description":"List of performers that have been assigned to the task.", "exampleSetFlag":false, "types":[ "string" ] }, "status":{ "type":"string", "description":"The status of the task assignment for the performer.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "STOPPED", "FINISHED", "FAILED", "EXECUTING", "SKIPPED" ] } }, "exampleSetFlag":false }, "ApiEntityWorkflowConfiguration":{ "title":"ApiEntityWorkflowConfiguration", "type":"object", "properties":{ "configurationGroupedByWorkspaceCode":{ "type":"object", "description":"Workflow configuration names grouped by workspace code.", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_DB_DOCUMENT_KEY:WORKFLOW_CONFIG,WS_CODE_MAP" } }, "configurationGroupedByWorkspaceId":{ "type":"object", "description":"Workflow configuration names grouped by workspace ID.", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_DB_DOCUMENT_KEY:WORKFLOW_CONFIG,WS_ID_MAP" } } }, "exampleSetFlag":false }, "ApiEntityWorkspaceUserPermissionsResponse":{ "title":"ApiEntityWorkspaceUserPermissionsResponse", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"Profiles response with individual message and statusCodes.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfileResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceProfileInput":{ "title":"ApiEntityWorkspaceProfileInput", "type":"object", "properties":{ "workspaceProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the workspace profile.", "exampleSetFlag":false, "types":[ "string" ] }, "programProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the program profile.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the portfolio profile.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the idea profile.", "exampleSetFlag":false, "types":[ "string" ] }, "projectProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the project profile.", "exampleSetFlag":false, "types":[ "string" ] }, "fileProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the document profile.", "exampleSetFlag":false, "types":[ "string" ] }, "reportProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the report profile.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the custom log profile.", "exampleSetFlag":false, "types":[ "string" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceUserPermissions":{ "title":"ApiEntityWorkspaceUserPermissions", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceUserGroupPermissionInput":{ "title":"ApiEntityWorkspaceUserGroupPermissionInput", "type":"object", "properties":{ "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceUserGroupProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceUserGroupProfileInput":{ "title":"ApiEntityWorkspaceUserGroupProfileInput", "type":"object", "properties":{ "userGroupId":{ "type":"string", "description":"System-defined identifier of the user group.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the workspace profile.", "exampleSetFlag":false, "types":[ "string" ] }, "programProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the program profile.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the portfolio profile.", "exampleSetFlag":false, "types":[ "string" ] }, "ideaProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the idea profile.", "exampleSetFlag":false, "types":[ "string" ] }, "projectProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the project profile.", "exampleSetFlag":false, "types":[ "string" ] }, "fileProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the document profile.", "exampleSetFlag":false, "types":[ "string" ] }, "reportProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the report profile.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogProfileId":{ "maxLength":255, "type":"string", "description":"System-defined identifier of the custom log profile.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceUserGroupAssignmentInput":{ "title":"ApiEntityWorkspaceUserGroupAssignmentInput", "type":"object", "properties":{ "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userNames":{ "type":"array", "description":"List of usernames of the users for user group assignment.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "userGroupId":{ "type":"integer", "description":"System-defined identifier of the user group.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspace":{ "title":"ApiEntityWorkspace", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceAutonumSettings":{ "type":"array", "description":"An object containing workspace autonumber settings.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceAutonumSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceCurrencySetting":{ "description":"Entity to create or update default currency and view the parent workspace currencies.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityWorkspaceCurrencySetting" } ] }, "description":{ "maxLength":4000, "type":"string", "description":"Summary of the workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceSettings":{ "type":"array", "description":"An object containing workspace settings.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceSetting", "exampleSetFlag":false }, "types":[ "array" ] }, "parentWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The parent workspace code of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "isProduction":{ "type":"boolean", "description":"Indicates a workspace that is in production.
                                                                                                                                                                                                                                                                                                                            All workspaces created under the Production workspace are automatically designated as production.
                                                                                                                                                                                                                                                                                                                            This cannot be changed.", "exampleSetFlag":false, "types":[ "boolean" ] }, "isSysGenerated":{ "type":"boolean", "description":"Indicates a workspace that was created by the system.
                                                                                                                                                                                                                                                                                                                            System generated workspaces cannot be deleted.", "exampleSetFlag":false, "types":[ "boolean" ] }, "securityGuid":{ "maxLength":32, "type":"string", "description":"The Globally Unique Identifier of the workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"Determines the order of appearance of workspaces in a list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of the workspace hierarchically above another workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceName":{ "maxLength":255, "minLength":1, "type":"string", "description":"Name of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "image":{ "description":"An image associated with the workspace.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityWorkspaceImage" } ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceAutonumSetting":{ "title":"ApiEntityWorkspaceAutonumSetting", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "prefix":{ "maxLength":20, "type":"string", "description":"Initial characters for the workspace auto numbering sequence.", "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":50, "type":"string", "description":"Name of the auto numbering sequence.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "autonumId":{ "type":"integer", "description":"The unique identifier of an auto numbering sequence.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "increment":{ "type":"integer", "description":"Number by which the auto numbering suffix is incremented.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "suffix":{ "maxLength":20, "type":"string", "description":"The first number in the workspace auto numbering sequence.", "exampleSetFlag":false, "types":[ "string" ] }, "area":{ "type":"string", "description":"Identifies the type of object used for auto numbering.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "IDEA", "PROGRAM", "PROJECT", "ACTIVITY", "SCHEDULE_SCENARIO", "ACTIVITY_ASSIGNMENT", "WBS", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGE", "PROGRAM_BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "PROG_RISK", "ACTUALS", "WORK_MANAGER_TASK", "CONSTRAINT", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM", "RESOURCE", "RISK_MITIGATION", "PROGRAM_RISK_MITIGATION" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceCurrencySetting":{ "title":"ApiEntityWorkspaceCurrencySetting", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "defaultCurrencyExchangeRate":{ "type":"number", "description":"The exchange rate of the workspace default currency.", "exampleSetFlag":false, "types":[ "number" ] }, "workspaceCurrency1ExchangeRate":{ "type":"number", "description":"The exchange rate of the default currency of the first workspace in the hierarchy.", "exampleSetFlag":false, "types":[ "number" ] }, "workspaceCurrency2ExchangeRate":{ "type":"number", "description":"The exchange rate of the default currency of the second workspace in the hierarchy.", "exampleSetFlag":false, "types":[ "number" ] }, "workspaceCurrency3ExchangeRate":{ "type":"number", "description":"The exchange rate of the default currency of the third workspace in the hierarchy.", "exampleSetFlag":false, "types":[ "number" ] }, "workspaceCurrency1Id":{ "type":"integer", "description":"The system-generated identifier of the default currency of the first workspace in the hierarchy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCurrency2Id":{ "type":"integer", "description":"The system-generated identifier of the default currency of the second workspace in the hierarchy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCurrency3Id":{ "type":"integer", "description":"The system-generated identifier of the default currency of the third workspace in the hierarchy.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "defaultCurrencyId":{ "type":"integer", "description":"The workspace default currency that is selected on the workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceImage":{ "title":"ApiEntityWorkspaceImage", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "workspaceImageId":{ "type":"integer", "description":"The unique identifier of the image.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "imageType":{ "type":"string", "description":"The file type of the image. Valid values are PNG, JPEG, and GIF.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PNG", "JPEG", "GIF" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of the workspace that contains this image.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "image":{ "type":"string", "description":"An image object represented in binary format.", "format":"byte", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceSetting":{ "title":"ApiEntityWorkspaceSetting", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceSettingId":{ "type":"integer", "description":"The unique identifier of a workspace setting.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "settingName":{ "maxLength":255, "minLength":0, "type":"string", "description":"Name of a workspace setting.", "exampleSetFlag":false, "types":[ "string" ] }, "settingValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"Value of a workspace setting.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace setting.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityWorkspaceCurrencySettingInput":{ "title":"ApiEntityWorkspaceCurrencySettingInput", "type":"object", "properties":{ "defaultCurrencyId":{ "type":"integer", "description":"The workspace default currency that is selected on the workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a WorkspaceCurrencySetting object, a unique WorkspaceCurrencySetting object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                            • workspaceId
                                                                                                                                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityWorkspaceInput":{ "title":"ApiEntityWorkspaceInput", "required":[ "parentId", "workspaceCode", "workspaceName" ], "type":"object", "properties":{ "workspaceCurrencySetting":{ "description":"Entity to create or update default currency and view the parent workspace currencies.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityWorkspaceCurrencySettingInput" } ] }, "description":{ "maxLength":4000, "type":"string", "description":"Summary of the workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceSettings":{ "type":"array", "description":"An object containing workspace settings.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityWorkspaceSettingInput", "exampleSetFlag":false }, "types":[ "array" ] }, "parentWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The parent workspace code of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of the workspace hierarchically above another workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceName":{ "maxLength":255, "minLength":1, "type":"string", "description":"Name of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "description":"This entity represents a Workspace object, a unique Workspace object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                              • workspaceId
                                                                                                                                                                                                                                                                                                                              • workspaceCode,parentId
                                                                                                                                                                                                                                                                                                                              • workspaceCode,parentWorkspaceCode
                                                                                                                                                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityWorkspaceSettingInput":{ "title":"ApiEntityWorkspaceSettingInput", "type":"object", "properties":{ "workspaceSettingId":{ "type":"integer", "description":"The unique identifier of a workspace setting.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "settingName":{ "maxLength":255, "minLength":0, "type":"string", "description":"Name of a workspace setting.", "exampleSetFlag":false, "types":[ "string" ] }, "settingValue":{ "maxLength":255, "minLength":0, "type":"string", "description":"Value of a workspace setting.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCurrencyOfRecord":{ "title":"ApiEntityCurrencyOfRecord", "type":"object", "properties":{ "currencyOfRecord":{ "maxLength":255, "type":"string", "description":"This field represents the currency of record i.e. editable currency of a cost field for a given workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyCode":{ "maxLength":3, "minLength":1, "type":"string", "description":"The unique identifier for the currency. The currency code is 3 characters.", "exampleSetFlag":false, "types":[ "string" ] }, "currencyId":{ "type":"integer", "description":"The unique identifier of a currency.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "exchangeRate":{ "type":"number", "description":"The conversion rate between this currency and base currency.", "exampleSetFlag":false, "types":[ "number" ] } }, "exampleSetFlag":false }, "ApiEntityAssignedPermissions":{ "title":"ApiEntityAssignedPermissions", "type":"object", "properties":{ "file":{ "description":"File permission sets.
                                                                                                                                                                                                                                                                                                                                Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "portfolio":{ "description":"Portfolio permission sets.
                                                                                                                                                                                                                                                                                                                                Applicable for workspace, portfolio retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "customLog":{ "description":"Custom log permission sets.
                                                                                                                                                                                                                                                                                                                                Applicable for workspace, project, program, customLogTypeObject retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "workspace":{ "description":"Workspace permission sets.
                                                                                                                                                                                                                                                                                                                                Applicable for workspace retrieve API.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "project":{ "description":"Project permission sets.
                                                                                                                                                                                                                                                                                                                                Applicable for workspace, project retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "report":{ "description":"Report permission sets.
                                                                                                                                                                                                                                                                                                                                Applicable for workspace, project, program, portfolio, report retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "program":{ "description":"Program permission sets.
                                                                                                                                                                                                                                                                                                                                Applicable for workspace, program retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] }, "idea":{ "description":"Idea permission sets.
                                                                                                                                                                                                                                                                                                                                Applicable for workspace, idea retrieve APIs.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityBaseProfile" } ] } }, "exampleSetFlag":false }, "ApiEntityUserGroupsPermissionAssignments":{ "title":"ApiEntityUserGroupsPermissionAssignments", "type":"object", "properties":{ "userGroupName":{ "type":"string", "description":"The name displayed of the user group.", "exampleSetFlag":false, "types":[ "string" ] }, "assignedPermissions":{ "description":"List of assigned user permission profiles in the user group.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityAssignedPermissions" } ] }, "assignedUsers":{ "type":"array", "description":"List of assigned users in the user group.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityAssignedUsers", "exampleSetFlag":false }, "types":[ "array" ] }, "userGroupId":{ "type":"string", "description":"The unique identifier of the user group.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityUserPermissionAssignments":{ "title":"ApiEntityUserPermissionAssignments", "type":"object", "properties":{ "displayName":{ "type":"string", "description":"The name displayed of the user when logged into the system. ", "exampleSetFlag":false, "types":[ "string" ] }, "assignedPermissions":{ "description":"List of assigned user permission profiles.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityAssignedPermissions" } ] }, "userName":{ "type":"string", "description":"The identification used by a user to log in to the system.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveWorkspaceUserGroupPermissionsResponse":{ "title":"ApiEntityRemoveWorkspaceUserGroupPermissionsResponse", "type":"object", "properties":{ "message":{ "type":"string", "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "userGroupId":{ "type":"string", "description":"System-defined identifier of the user group.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveWorkspaceUserGroupPermissions":{ "title":"ApiEntityRemoveWorkspaceUserGroupPermissions", "type":"object", "properties":{ "userGroupIds":{ "type":"array", "description":"List of user group IDs for removing user groups.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveWorkspaceUserPermissionsResponse":{ "title":"ApiEntityRemoveWorkspaceUserPermissionsResponse", "type":"object", "properties":{ "message":{ "type":"string", "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The response code representing the state of the API operation.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityRemoveWorkspaceUserPermissions":{ "title":"ApiEntityRemoveWorkspaceUserPermissions", "type":"object", "properties":{ "userNames":{ "type":"array", "description":"List of user names for removing users.", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueCustomLog":{ "title":"ApiEntityCodeValueCustomLog", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueCustomLogId":{ "type":"integer", "description":"The system-generated identifier of a custom log.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogItemId":{ "type":"integer", "description":"The system-generated identifier of a document.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogItem":{ "title":"ApiEntityCustomLogItem", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "ballInCourtUserName":{ "maxLength":255, "type":"string", "description":"The user-specified identifier of the user associated with the object.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeObjectName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The user-specified identifier of a custom log type.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogItemId":{ "type":"integer", "description":"The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"A unique identifier unique of the custom log item.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"A unique identifier of a Program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Notes about the custom log item.", "exampleSetFlag":false, "types":[ "string" ] }, "udfValues":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogItemConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "postedDate":{ "type":"string", "description":"The date the custom log item was added.", "format":"date-time", "exampleSetFlag":false }, "customLogsItemName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the custom log item.", "exampleSetFlag":false, "types":[ "string" ] }, "ballInCourtId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a custom log item. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueCustomLog", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the custom log item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT" ] }, "dueDate":{ "type":"string", "description":"The date the custom log item is due.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogItemConfiguredFieldValue":{ "title":"ApiEntityCustomLogItemConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "customLogConfiguredFieldValueId":{ "type":"integer", "description":"The system-generated identifier of a flex field value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogItemId":{ "type":"integer", "description":"The system-generated identifier of a document.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueCustomLogInput":{ "title":"ApiEntityCodeValueCustomLogInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueCustomLogId":{ "type":"integer", "description":"The system-generated identifier of a custom log.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogItemId":{ "type":"integer", "description":"The system-generated identifier of a document.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueCustomLog object, a unique CodeValueCustomLog object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                • codeValueCustomLogId
                                                                                                                                                                                                                                                                                                                                • codeValueId
                                                                                                                                                                                                                                                                                                                                • codeTypeId,codeValueCode
                                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode
                                                                                                                                                                                                                                                                                                                                • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                                                                                                                                                • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                                                                                                                                                • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityCustomLogItemConfiguredFieldValueInput":{ "title":"ApiEntityCustomLogItemConfiguredFieldValueInput", "type":"object", "properties":{ "customLogConfiguredFieldValueId":{ "type":"integer", "description":"The system-generated identifier of a flex field value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogItemId":{ "type":"integer", "description":"The system-generated identifier of a document.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CustomLogItemConfiguredFieldValue object, a unique CustomLogItemConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                  • customLogItemConfiguredFieldValueId
                                                                                                                                                                                                                                                                                                                                  • columnDefinitionId
                                                                                                                                                                                                                                                                                                                                  • columnName
                                                                                                                                                                                                                                                                                                                                  • columnLabel
                                                                                                                                                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityCustomLogItemInput":{ "title":"ApiEntityCustomLogItemInput", "required":[ "customLogTypeObjectId", "customLogsItemName", "projectId" ], "type":"object", "properties":{ "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "ballInCourtUserName":{ "maxLength":255, "type":"string", "description":"The user-specified identifier of the user associated with the object.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeObjectName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The user-specified identifier of a custom log type.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The unique identifier for a program set by the user who created the program.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogItemId":{ "type":"integer", "description":"The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"A unique identifier unique of the custom log item.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"A unique identifier of a Program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "comment":{ "maxLength":4000, "minLength":0, "type":"string", "description":"Notes about the custom log item.", "exampleSetFlag":false, "types":[ "string" ] }, "udfValues":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogItemConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "customLogsItemName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of the custom log item.", "exampleSetFlag":false, "types":[ "string" ] }, "ballInCourtId":{ "type":"integer", "description":"The system-generated identifier of a user.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValues":{ "type":"array", "description":"The list of code values for a custom log item. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueCustomLogInput", "exampleSetFlag":false }, "types":[ "array" ] }, "status":{ "type":"string", "description":"The status of the custom log item.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DRAFT" ] }, "dueDate":{ "type":"string", "description":"The date the custom log item is due.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a CustomLogItem object, a unique CustomLogItem object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                    • customLogItemId
                                                                                                                                                                                                                                                                                                                                    • customLogItemCode,customLogTypeObjectId
                                                                                                                                                                                                                                                                                                                                    • customLogItemCode,customLogTypeObjectName,projectId
                                                                                                                                                                                                                                                                                                                                    • customLogItemCode,customLogTypeObjectName,projectCode,workspaceCode
                                                                                                                                                                                                                                                                                                                                    • customLogItemCode,customLogTypeObjectName,programId
                                                                                                                                                                                                                                                                                                                                    • customLogItemCode,customLogTypeObjectName,programCode,workspaceCode
                                                                                                                                                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityCustomLogTypeObjectAssignResponse":{ "title":"ApiEntityCustomLogTypeObjectAssignResponse", "type":"object", "properties":{ "warning":{ "type":"string", "description":"Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "errorMessage":{ "type":"string", "description":"Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeObject":{ "description":"This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.", "readOnly":true, "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier" } ] }, "workspaces":{ "type":"array", "description":"This field represents the list of workspace records along with the status of the assign operation.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityGenericResponseWorkspaceIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "statusCode":{ "type":"integer", "description":"The status code of the operation on a given object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programs":{ "type":"array", "description":"This field represents the list of program records along with the status of the assign operation.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityGenericResponseProgramIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "projects":{ "type":"array", "description":"This field represents the list of project records along with the status of the assign operation.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityGenericResponseProjectIdentifier", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityGenericResponseProgramIdentifier":{ "title":"ApiEntityGenericResponseProgramIdentifier", "type":"object", "properties":{ "object":{ "description":"The object the operation performed on.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ProgramIdentifier" } ] }, "errorMessage":{ "type":"string", "description":"Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The status code of the operation on a given object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "warning":{ "type":"string", "description":"Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityGenericResponseProjectIdentifier":{ "title":"ApiEntityGenericResponseProjectIdentifier", "type":"object", "properties":{ "object":{ "description":"The object the operation performed on.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ProjectIdentifier" } ] }, "errorMessage":{ "type":"string", "description":"Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The status code of the operation on a given object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "warning":{ "type":"string", "description":"Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityGenericResponseWorkspaceIdentifier":{ "title":"ApiEntityGenericResponseWorkspaceIdentifier", "type":"object", "properties":{ "object":{ "description":"The object the operation performed on.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/WorkspaceIdentifier" } ] }, "errorMessage":{ "type":"string", "description":"Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "statusCode":{ "type":"integer", "description":"The status code of the operation on a given object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "warning":{ "type":"string", "description":"Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogTypeObjectAssignRequestInput":{ "title":"ApiEntityCustomLogTypeObjectAssignRequestInput", "required":[ "customLogTypeObject" ], "type":"object", "properties":{ "customLogTypeObject":{ "description":"This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier" } ] }, "workspaces":{ "type":"array", "description":"This field represents the list of workspace records that the custom log type object needs to be assigned.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/WorkspaceIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "programs":{ "type":"array", "description":"This field represents the list of program records that the custom log type object needs to be assigned.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ProgramIdentifier", "exampleSetFlag":false }, "types":[ "array" ] }, "projects":{ "type":"array", "description":"This field represents the list of project records that the custom log type object needs to be assigned.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ProjectIdentifier", "exampleSetFlag":false }, "types":[ "array" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogTypeObjectUserPermissionsResponse":{ "title":"ApiEntityCustomLogTypeObjectUserPermissionsResponse", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "profiles":{ "type":"array", "description":"Profiles response with individual message and statusCodes.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityProfileResponse", "exampleSetFlag":false }, "types":[ "array" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The unique identifier for the project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogTypeObjectProfileInput":{ "title":"ApiEntityCustomLogTypeObjectProfileInput", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeObjectProfileId":{ "type":"integer", "description":"System-defined identifier of the document profile.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "userName":{ "maxLength":255, "type":"string", "description":"Username of the user for permission assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogTypeObjectUserPermissions":{ "title":"ApiEntityCustomLogTypeObjectUserPermissions", "required":[ "customLogTypeObjectName", "scope", "scopeId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "scopeId":{ "type":"integer", "description":"The system-generated identifier of a reference to another object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "profiles":{ "type":"array", "description":"List of user profiles.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeObjectProfileInput", "exampleSetFlag":false }, "types":[ "array" ] }, "customLogTypeObjectName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The user-defined identifier of a custom log type object.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeCode":{ "maxLength":60, "type":"string", "description":"The user-defined identifier of a reference to another object.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The system-generated identifier of custom log type object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "maxLength":40, "type":"string", "description":"The scope of an object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "project", "program", "workspace" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogEntityType":{ "title":"ApiEntityCustomLogEntityType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "customLogEntityTypeId":{ "type":"integer", "description":"The system-generated identifier of custom log type object and entity association.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "entityType":{ "type":"string", "description":"Indicates the type of object the custom log type object is associated to.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROGRAM", "PROJECT" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogTypeCodeType":{ "title":"ApiEntityCustomLogTypeCodeType", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeCodeTypeId":{ "type":"integer", "description":"The system-generated identifier of a doc type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The system-generated identifier of a custom log type object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeId":{ "type":"integer", "description":"The system-generated identifier of a code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogTypeObject":{ "title":"ApiEntityCustomLogTypeObject", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeId":{ "type":"integer", "description":"The system-generated identifier of a reference to another object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogUdfs":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogUdf", "exampleSetFlag":false }, "types":[ "array" ] }, "assignedWorkspaceCode":{ "maxLength":60, "type":"string", "description":"The user defined identifier of the workspace for which the custom log type belongs.", "exampleSetFlag":false, "types":[ "string" ] }, "ownershipType":{ "type":"string", "description":"The ownership type of the custom log type object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE", "PROJECT", "PROGRAM" ] }, "customLogTypeObjectName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The user-defined identifier of a custom log type object.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeCode":{ "maxLength":60, "type":"string", "description":"The user-defined identifier of a reference to another object.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeCodeTypes":{ "type":"array", "description":"The code types associated with a custom log type object.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeCodeType", "exampleSetFlag":false }, "types":[ "array" ] }, "securityGuid":{ "maxLength":32, "type":"string", "description":"The globally unique identifier of an object.", "exampleSetFlag":false, "types":[ "string" ] }, "sequenceNumber":{ "type":"integer", "description":"The sequence number of an object.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "appliesTo":{ "type":"array", "description":"The list of code type assignments.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogEntityType", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                                                                                                                                                                                                                                      Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                                                                                                                                                                                                                      Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association between a document and an object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "assignedWorkspaceId":{ "type":"integer", "description":"The system generated identifier of the workspace for which the custom log type belongs.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The system-generated identifier of custom log type object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "scope":{ "maxLength":40, "type":"string", "description":"The scope of an object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "project", "program", "workspace" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogUdf":{ "title":"ApiEntityCustomLogUdf", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "customLogUdfId":{ "type":"integer", "description":"The system-generated identifier of a code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogObjectId":{ "type":"integer", "description":"The system-generated identifier of custom log type object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "fdColumnId":{ "type":"integer", "description":"The system-generated identifier of a column.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogEntityTypeInput":{ "title":"ApiEntityCustomLogEntityTypeInput", "type":"object", "properties":{ "customLogEntityTypeId":{ "type":"integer", "description":"The system-generated identifier of custom log type object and entity association.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "entityType":{ "type":"string", "description":"Indicates the type of object the custom log type object is associated to.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PROGRAM", "PROJECT" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogTypeCodeTypeInput":{ "title":"ApiEntityCustomLogTypeCodeTypeInput", "type":"object", "properties":{ "customLogTypeCodeTypeId":{ "type":"integer", "description":"The system-generated identifier of a doc type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The system-generated identifier of a custom log type object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeId":{ "type":"integer", "description":"The system-generated identifier of a code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityCustomLogTypeObjectInput":{ "title":"ApiEntityCustomLogTypeObjectInput", "required":[ "customLogTypeObjectName", "scope", "scopeId", "workspaceId" ], "type":"object", "properties":{ "scopeId":{ "type":"integer", "description":"The system-generated identifier of a reference to another object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogUdfs":{ "type":"array", "description":"An object containing configured fields in the form of key-value pairs.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogUdfInput", "exampleSetFlag":false }, "types":[ "array" ] }, "customLogTypeObjectName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The user-defined identifier of a custom log type object.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeCode":{ "maxLength":60, "type":"string", "description":"The user-defined identifier of a reference to another object.", "exampleSetFlag":false, "types":[ "string" ] }, "customLogTypeCodeTypes":{ "type":"array", "description":"The code types associated with a custom log type object.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogTypeCodeTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "appliesTo":{ "type":"array", "description":"The list of code type assignments.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCustomLogEntityTypeInput", "exampleSetFlag":false }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                                                                                                                                                                                                                                      Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                                                                                                                                                                                                                      Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "customLogTypeObjectId":{ "type":"integer", "description":"The system-generated identifier of custom log type object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scope":{ "maxLength":40, "type":"string", "description":"The scope of an object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "project", "program", "workspace" ] } }, "description":"This entity represents a CustomLogTypeObject object, a unique CustomLogTypeObject object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                      • customLogTypeObjectId
                                                                                                                                                                                                                                                                                                                                      • customLogTypeObjectName,scope,scopeId
                                                                                                                                                                                                                                                                                                                                      • customLogTypeObjectName,scope,scopeCode,workspaceId
                                                                                                                                                                                                                                                                                                                                      • customLogTypeObjectName,scope,scopeCode,workspaceCode
                                                                                                                                                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityCustomLogUdfInput":{ "title":"ApiEntityCustomLogUdfInput", "type":"object", "properties":{ "customLogUdfId":{ "type":"integer", "description":"The system-generated identifier of a code type.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "customLogObjectId":{ "type":"integer", "description":"The system-generated identifier of custom log type object.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "exampleSetFlag":false, "types":[ "string" ] }, "fdColumnId":{ "type":"integer", "description":"The system-generated identifier of a column.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "exampleSetFlag":false }, "ApiEntityEntityReference":{ "title":"ApiEntityEntityReference", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "fromType":{ "type":"string", "description":"The type of the object the reference is from.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] }, "fromTypeRecordCode":{ "type":"string", "description":"The user-specified identifier of an object associated with a reference.", "exampleSetFlag":false, "types":[ "string" ] }, "toTypeRecordCode":{ "type":"string", "description":"The user-specified identifier of an object associated with a reference.", "exampleSetFlag":false, "types":[ "string" ] }, "entityReferenceId":{ "type":"integer", "description":"The system-generated identifier of a reference.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "programCode":{ "type":"string", "description":"The user-specified unique identifier of a program.", "exampleSetFlag":false, "types":[ "string" ] }, "toId":{ "type":"integer", "description":"The system-generated identifier of the object a reference is a reference to.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "toType":{ "type":"string", "description":"The type of the object a reference refers to.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] }, "fromId":{ "type":"integer", "description":"The system-generated identifier of the object the reference is from.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityEntityReferenceInput":{ "title":"ApiEntityEntityReferenceInput", "required":[ "fromId", "fromType", "programCode", "projectCode", "toId", "toType", "workspaceCode" ], "type":"object", "properties":{ "fromType":{ "type":"string", "description":"The type of the object the reference is from.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] }, "fromTypeRecordCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of an object associated with a reference.", "exampleSetFlag":false, "types":[ "string" ] }, "toTypeRecordCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of an object associated with a reference.", "exampleSetFlag":false, "types":[ "string" ] }, "entityReferenceId":{ "type":"integer", "description":"The system-generated identifier of a reference.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier of a program.", "exampleSetFlag":false, "types":[ "string" ] }, "toId":{ "type":"integer", "description":"The system-generated identifier of the object a reference is a reference to.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "toType":{ "type":"string", "description":"The type of the object a reference refers to.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ] }, "fromId":{ "type":"integer", "description":"The system-generated identifier of the object the reference is from.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityFilterCondition":{ "title":"ApiEntityFilterCondition", "required":[ "equality", "fieldPath", "join", "value" ], "type":"object", "properties":{ "value":{ "type":"object", "description":"Contains the allocation rule filter condition value.", "exampleSetFlag":false, "types":[ "object" ], "jsonSchema":{ "type":"object", "description":"PRIMAVERA_DB_DOCUMENT_KEY:fund_resource_filter_value" } }, "fieldPath":{ "type":"string", "description":"Contains the allocation rule filter field.
                                                                                                                                                                                                                                                                                                                                        The field is non-persistable and thus maximum length is not applicable.", "exampleSetFlag":false, "types":[ "string" ] }, "equality":{ "type":"string", "description":"Contains the allocation rule filter condition equality.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EQUALS", "NOT_EQUALS", "EQUALS_IGNORE_CASE", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "IN", "NOT_IN", "STARTS_WITH", "ENDS_WITH", "LIKE", "NOT_LIKE", "BETWEEN", "NOT_BETWEEN", "IS_NULL", "NOT_NULL", "IS_EMPTY", "IS_UNDER" ] }, "conditions":{ "type":"array", "description":"Contains the allocation rule filter condition.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFilterCondition", "exampleSetFlag":false }, "types":[ "array" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "parentCodeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "join":{ "type":"string", "description":"Contains the allocation rule filter join operation.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "AND", "OR", "NULL" ] } }, "exampleSetFlag":false }, "ApiEntityNamedFilter":{ "title":"ApiEntityNamedFilter", "required":[ "conditions", "name", "workspaceId" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "name":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the filter.", "exampleSetFlag":false, "types":[ "string" ] }, "conditions":{ "type":"array", "description":"Contains the allocation rule filter condition.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFilterCondition", "exampleSetFlag":false }, "types":[ "array" ] }, "filterId":{ "type":"integer", "description":"The unique identifier of the allocation rule.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier of the workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "ownerId":{ "type":"integer", "description":"The system-generated unique identifier of a user who has created the filter.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a NamedFilter object, a unique NamedFilter object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                        • filterId
                                                                                                                                                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityCodeValueFund":{ "title":"ApiEntityCodeValueFund", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueFundId":{ "type":"integer", "description":"The unique identifier for the fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundId":{ "type":"integer", "description":"The unique identification code of the fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sequenceNumber":{ "type":"integer", "description":"The number that specifies the position of the code value item within the code type list.", "format":"int32", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeName":{ "maxLength":255, "minLength":0, "type":"string", "description":"The name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFund":{ "title":"ApiEntityFund", "required":[ "endDate", "fundCode", "fundName", "startDate" ], "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "fundCost":{ "description":"Defines the fund cost of a fund.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFundCost" } ] }, "spreadRows":{ "type":"array", "description":"Defines the spread rows for a fund.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundSpreadRow", "exampleSetFlag":false }, "types":[ "array" ] }, "type":{ "type":"string", "description":"The kind of object with which the fund is associated. This can either be Project, Program or Workspace.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE_FUND", "PROJECT_FUND", "PORTFOLIO_FUND", "PROGRAM_FUND" ] }, "portfolioCode":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "parentFundCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identification code of the fund.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValuesFund":{ "type":"array", "description":"The list of code values for a fund. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueFund", "exampleSetFlag":false }, "types":[ "array" ] }, "distributionType":{ "type":"string", "description":"Specifies how money is distributed for the fund.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "YEARLY", "QUARTERLY", "MONTHLY", "LUMP_SUM" ] }, "fromAllocation":{ "type":"boolean", "description":"Specifies whether the fund has allocations.", "exampleSetFlag":false, "types":[ "boolean" ] }, "hasAllocations":{ "type":"boolean", "description":"Specifies whether the fund has allocations.", "exampleSetFlag":false, "types":[ "boolean" ] }, "appropriationType":{ "type":"string", "description":"The type of appropriation.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "MANUAL", "FROM_ALLOCATION" ] }, "consumptionType":{ "type":"string", "description":"The type of consumption.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "MANUAL", "FROM_ALLOCATION", "FROM_ACTUAL" ] }, "parentFundId":{ "type":"integer", "description":"The unique identification code of the parent fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentWorkspaceId":{ "type":"integer", "description":"The user-specified identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "fundName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the fund.", "exampleSetFlag":false, "types":[ "string" ] }, "fundCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identification code of the fund.", "exampleSetFlag":false, "types":[ "string" ] }, "fundStatus":{ "type":"string", "description":"Either Active or Inactive. Inactive funds cannot be allocated or appropriated. They can only be consumed for projects or programs.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The date when money in the fund will start being available.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier of a program.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a fund.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundConfiguredFieldValue", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The system-generated unique identifier of a program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "endDate":{ "type":"string", "description":"The date when money in the fund will no longer be available.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "fundId":{ "type":"integer", "description":"The system generated identifier of a fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundAllocationSpreadRow":{ "title":"ApiEntityFundAllocationSpreadRow", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "fundAllocationSpreadRowCost":{ "description":"Defines the cost associated with the spread rows of the workspace total item.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRowCost" } ] }, "fundAllocationSpreadRowId":{ "type":"integer", "description":"The unique identification code of the allocation row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundSpreadRowId":{ "type":"integer", "description":"The unique identification code of the spread row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundId":{ "type":"integer", "description":"The unique identification code of the fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fund":{ "description":"The unique identification code of the fund.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFund" } ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundAllocationSpreadRowCost":{ "title":"ApiEntityFundAllocationSpreadRowCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "fundAllocationSpreadRowId":{ "type":"integer", "description":"The unique identification code of the allocation row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "allocatedProject":{ "type":"number", "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocated":{ "type":"number", "description":"The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundConfiguredFieldValue":{ "title":"ApiEntityFundConfiguredFieldValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "fundConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for funds configured field", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundId":{ "type":"integer", "description":"The system-generated identifier for funds", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "costValue":{ "type":"number", "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.", "exampleSetFlag":false, "types":[ "number" ] }, "hasException":{ "type":"boolean", "description":"Determines if formula calculation hit an error calculating a value for this field.", "exampleSetFlag":false, "types":[ "boolean" ] }, "exceptionMessage":{ "maxLength":4000, "type":"string", "description":"Provides the error message for why the formula calculation resulted in an error.", "exampleSetFlag":false, "types":[ "string" ] }, "costValueWorkspace1":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace2":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.", "format":"double", "exampleSetFlag":false }, "costValueWorkspace3":{ "type":"number", "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.", "format":"double", "exampleSetFlag":false }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundCost":{ "title":"ApiEntityFundCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "remaining":{ "type":"number", "description":"The portion of the fund that has not been consumed. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace3":{ "minimum":0, "type":"number", "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "distributedTotalWorkspace1":{ "type":"number", "description":"The amount of money that has been distributed for the fund. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "distributedTotalWorkspace2":{ "type":"number", "description":"The amount of money that has been distributed for the fund. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "distributedTotalWorkspace3":{ "type":"number", "description":"The amount of money that has been distributed for the fund. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "undistributedTotalWorkspace1":{ "type":"number", "description":"The amount of money that has not been distributed for the fund. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "undistributedTotalWorkspace2":{ "type":"number", "description":"The amount of money that has not been distributed for the fund. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "undistributedTotalWorkspace3":{ "type":"number", "description":"The amount of money that has not been distributed for the fund. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "undistributedTotalProject":{ "type":"number", "description":"The amount of money that has not been distributed for the fund. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "totalProject":{ "minimum":0, "type":"number", "description":"The amount of money granted for the fund. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "appropriatedProject":{ "minimum":0, "type":"number", "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedProject":{ "type":"number", "description":"The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "consumedProject":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on a project. The portion of the fund that has been spent to complete work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingProject":{ "type":"number", "description":"The portion of the fund that has not been consumed. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocatedProject":{ "type":"number", "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unallocatedProject":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "distributedTotal":{ "type":"number", "description":"The amount of money that has been distributed for the fund. This field is in base currency and is calculated from distributedTotalProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "distributedTotalProject":{ "type":"number", "description":"The amount of money that has been distributed for the fund. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "undistributedTotal":{ "type":"number", "description":"The amount of money that has not been distributed for the fund. This field is in base currency and is calculated from undistributedTotalProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "unallocated":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "unallocatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unallocatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unallocatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects, programs or in other workspaces. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "appropriated":{ "minimum":0, "type":"number", "description":"The portion of the fund that has been committed to work on projects or programs. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "unappropriated":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "consumed":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects or programs. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "allocated":{ "type":"number", "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace1":{ "minimum":0, "type":"number", "description":"The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace2":{ "minimum":0, "type":"number", "description":"The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace3":{ "minimum":0, "type":"number", "description":"The portion of the fund that has been committed to work on projects or programs. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace1":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace2":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace3":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects or programs. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace1":{ "type":"number", "description":"The portion of the fund that has not been consumed. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace2":{ "type":"number", "description":"The portion of the fund that has not been consumed. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace3":{ "type":"number", "description":"The portion of the fund that has not been consumed. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has been distributed to projects, programs, or other workspaces. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace1":{ "minimum":0, "type":"number", "description":"The amount of money granted for the fund. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace2":{ "minimum":0, "type":"number", "description":"The amount of money granted for the fund. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace3":{ "minimum":0, "type":"number", "description":"The amount of money granted for the fund. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "fundId":{ "type":"integer", "description":"The system generated identifier of a fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "total":{ "minimum":0, "type":"number", "description":"The amount of money granted for the fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundCostSpreadRow":{ "title":"ApiEntityFundCostSpreadRow", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "remaining":{ "type":"number", "description":"The amount left to be spent.
                                                                                                                                                                                                                                                                                                                                          If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                                                                                                                                                                                                                                                                                          If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This field is in base currency and is calculated from remainingProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "totalProject":{ "type":"number", "description":"The amount of money granted for the fund. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "appropriatedProject":{ "type":"number", "description":"The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedProject":{ "type":"number", "description":"The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "consumedProject":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingProject":{ "type":"number", "description":"The portion of the fund that has not been consumed. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocatedProject":{ "type":"number", "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unallocatedProject":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "fundSpreadRowId":{ "type":"integer", "description":"The unique identification code of the spread row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unallocated":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This field is in base currency and is calculated from unallocatedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "unallocatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unallocatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unallocatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "appropriated":{ "type":"number", "description":"The portion of the fund that has been committed to work on projects. This field is in base currency and is calculated from appropriatedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "unappropriated":{ "type":"number", "description":"The portion of the fund that has not been committed to actual work. This field is in base currency and is calculated from unappropriatedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "consumed":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects. This field is in base currency and is calculated from consumedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "allocated":{ "type":"number", "description":"The portion of the fund that has been distributed to projects or other workspaces. This field is in base currency and is calculated from allocatedProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has been committed to work on projects. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has been committed to work on projects. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has been committed to work on projects. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace1":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace2":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace3":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on projects. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace1":{ "type":"number", "description":"The amount left to be spent.
                                                                                                                                                                                                                                                                                                                                          If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                                                                                                                                                                                                                                                                                          If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace2":{ "type":"number", "description":"The amount left to be spent.
                                                                                                                                                                                                                                                                                                                                          If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                                                                                                                                                                                                                                                                                          If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace3":{ "type":"number", "description":"The amount left to be spent.
                                                                                                                                                                                                                                                                                                                                          If Rate By is set to Hours, then Remaining Cost equals Remaining Hours multiplied by Revised Cost Rate.
                                                                                                                                                                                                                                                                                                                                          If Rate By is set to Quantity, then Remaining Cost equals Remaining Quantity multiplied by Revised Cost Rate. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace1":{ "type":"number", "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace2":{ "type":"number", "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace3":{ "type":"number", "description":"The portion of the fund that has been distributed to projects or other workspaces. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace1":{ "type":"number", "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace2":{ "type":"number", "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace3":{ "type":"number", "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "total":{ "type":"number", "description":"The cost to be added to or subtracted from the workspace or portfolio fund. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundSpreadRow":{ "title":"ApiEntityFundSpreadRow", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "month":{ "type":"string", "description":"The time period during which funding takes place in months.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "fundAllocationSpreadRows":{ "type":"array", "description":"Defines the spread rows for a fund allocation.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRow", "exampleSetFlag":false }, "types":[ "array" ] }, "fundSpreadRowId":{ "type":"integer", "description":"The unique identification code of the spread row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundSpreadRowCost":{ "description":"Defines the cost associated with the spread rows of the fund.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFundCostSpreadRow" } ] }, "fundId":{ "type":"integer", "description":"The system generated identifier of a fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityCodeValueFundInput":{ "title":"ApiEntityCodeValueFundInput", "required":[ "codeTypeId", "codeValueCode" ], "type":"object", "properties":{ "codeValueFundId":{ "type":"integer", "description":"The unique identifier for the fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundId":{ "type":"integer", "description":"The unique identification code of the fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentId":{ "type":"integer", "description":"The unique identifier of a parent code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The code of a Project of a Project CodeType.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueId":{ "type":"integer", "description":"The unique identifier for the code value.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeValueCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValueName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the code value.", "exampleSetFlag":false, "types":[ "string" ] }, "codeTypeId":{ "type":"integer", "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "codeTypeCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"This field displays the name of a code or value.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "action":{ "type":"string", "description":"Provide a value for this field during object update to delete code value assigned to the object.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a CodeValueFund object, a unique CodeValueFund object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                          • codeValueFundId
                                                                                                                                                                                                                                                                                                                                          • codeValueId
                                                                                                                                                                                                                                                                                                                                          • codeTypeId,codeValueCode
                                                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode
                                                                                                                                                                                                                                                                                                                                          • codeTypeCode,parentId,codeValueCode
                                                                                                                                                                                                                                                                                                                                          • codeValueCode,codeTypeId,parentId
                                                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode,projectCode
                                                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode,projectId
                                                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode,parentId,projectCode
                                                                                                                                                                                                                                                                                                                                          • codeTypeCode,codeValueCode,parentId,projectId
                                                                                                                                                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityFundAllocationSpreadRowCostInput":{ "title":"ApiEntityFundAllocationSpreadRowCostInput", "type":"object", "properties":{ "fundAllocationSpreadRowId":{ "type":"integer", "description":"The unique identification code of the allocation row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "allocatedCOR":{ "type":"number", "description":"The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "allocatedProject":{ "type":"number", "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityFundAllocationSpreadRowInput":{ "title":"ApiEntityFundAllocationSpreadRowInput", "type":"object", "properties":{ "fundAllocationSpreadRowCost":{ "description":"Defines the cost associated with the spread rows of the workspace total item.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRowCostInput" } ] }, "fundAllocationSpreadRowId":{ "type":"integer", "description":"The unique identification code of the allocation row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundSpreadRowId":{ "type":"integer", "description":"The unique identification code of the spread row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundId":{ "type":"integer", "description":"The unique identification code of the fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityFundConfiguredFieldValueInput":{ "title":"ApiEntityFundConfiguredFieldValueInput", "type":"object", "properties":{ "fundConfiguredFieldValueId":{ "type":"integer", "description":"The unique identifier for funds configured field", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundId":{ "type":"integer", "description":"The system-generated identifier for funds", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "columnName":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column name.", "exampleSetFlag":false, "types":[ "string" ] }, "columnLabel":{ "maxLength":100, "minLength":1, "type":"string", "description":"The user-specified UDF column label.", "exampleSetFlag":false, "types":[ "string" ] }, "columnDefinitionId":{ "type":"integer", "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "textValue":{ "maxLength":4000, "type":"string", "description":"This holds values for Boolean, List and Text type configured fields.", "exampleSetFlag":false, "types":[ "string" ] }, "dateValue":{ "type":"string", "description":"This holds values for Date type configured fields.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "numberValue":{ "type":"number", "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.", "exampleSetFlag":false, "types":[ "number" ] }, "action":{ "type":"string", "description":"Provide value for this field during object update to delete the assigned configured field value.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "DELETE" ] } }, "description":"This entity represents a FundConfiguredFieldValue object, a unique FundConfiguredFieldValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                            • fundConfiguredFieldValueId
                                                                                                                                                                                                                                                                                                                                            • columnDefinitionId
                                                                                                                                                                                                                                                                                                                                            • columnName
                                                                                                                                                                                                                                                                                                                                            • columnLabel
                                                                                                                                                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityFundCostInput":{ "title":"ApiEntityFundCostInput", "type":"object", "properties":{ "undistributedTotalProject":{ "type":"number", "description":"The amount of money that has not been distributed for the fund. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "appropriatedCOR":{ "minimum":0, "type":"number", "description":"The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "remainingCOR":{ "type":"number", "description":"The portion of the fund that has not been consumed. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "unappropriatedCOR":{ "type":"number", "description":"The portion of the fund that has not yet been committed to actual work. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "unallocatedCOR":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "distributedTotalCOR":{ "type":"number", "description":"The amount of money that has been distributed for the fund. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "allocatedCOR":{ "type":"number", "description":"The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "undistributedTotalCOR":{ "type":"number", "description":"The amount of money that has not been distributed for the fund. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "consumedCOR":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on a project. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "totalProject":{ "minimum":0, "type":"number", "description":"The amount of money granted for the fund. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "appropriatedProject":{ "minimum":0, "type":"number", "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedProject":{ "type":"number", "description":"The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "consumedProject":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on a project. The portion of the fund that has been spent to complete work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingProject":{ "type":"number", "description":"The portion of the fund that has not been consumed. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocatedProject":{ "type":"number", "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unallocatedProject":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "distributedTotalProject":{ "type":"number", "description":"The amount of money that has been distributed for the fund. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "totalCOR":{ "minimum":0, "type":"number", "description":"The amount of money granted for the fund. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "fundId":{ "type":"integer", "description":"The system generated identifier of a fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityFundCostSpreadRowInput":{ "title":"ApiEntityFundCostSpreadRowInput", "type":"object", "properties":{ "appropriatedCOR":{ "type":"number", "description":"The portion of the fund that has not yet been committed to actual work. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "remainingCOR":{ "type":"number", "description":"The portion of the fund that has not been consumed. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "unappropriatedCOR":{ "type":"number", "description":"The portion of the fund that has not yet been committed to actual work. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "unallocatedCOR":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "allocatedCOR":{ "type":"number", "description":"The portion of the fund that has been committed to work on a project. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "consumedCOR":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on project. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false }, "totalProject":{ "type":"number", "description":"The amount of money granted for the fund. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "appropriatedProject":{ "type":"number", "description":"The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedProject":{ "type":"number", "description":"The portion of the fund that has not yet been committed to actual work. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "consumedProject":{ "type":"number", "description":"The portion of the fund that has been spent to complete work on project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "remainingProject":{ "type":"number", "description":"The portion of the fund that has not been consumed. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "allocatedProject":{ "type":"number", "description":"The portion of the fund that has been committed to work on a project. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "unallocatedProject":{ "type":"number", "description":"The portion of the fund that has not been reserved for work on projects or in other workspaces. This value is based on the project currency.", "format":"double", "exampleSetFlag":false }, "fundSpreadRowId":{ "type":"integer", "description":"The unique identification code of the spread row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "totalCOR":{ "type":"number", "description":"The amount of money granted for the fund. This is an input field, will not be a part of response.", "format":"double", "exampleSetFlag":false } }, "exampleSetFlag":false }, "ApiEntityFundInput":{ "title":"ApiEntityFundInput", "required":[ "endDate", "fundCode", "fundName", "startDate" ], "type":"object", "properties":{ "type":{ "type":"string", "description":"The kind of object with which the fund is associated. This can either be Project, Program or Workspace.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE_FUND", "PROJECT_FUND", "PORTFOLIO_FUND", "PROGRAM_FUND" ] }, "portfolioCode":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "parentFundCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identification code of the fund.", "exampleSetFlag":false, "types":[ "string" ] }, "codeValuesFund":{ "type":"array", "description":"The list of code values for a fund. This entity can only be used to assign codeValues or create codeValues on the fly.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityCodeValueFundInput", "exampleSetFlag":false }, "types":[ "array" ] }, "distributionType":{ "type":"string", "description":"Specifies how money is distributed for the fund.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "YEARLY", "QUARTERLY", "MONTHLY", "LUMP_SUM" ] }, "fromAllocation":{ "type":"boolean", "description":"Specifies whether the fund has allocations.", "exampleSetFlag":false, "types":[ "boolean" ] }, "hasAllocations":{ "type":"boolean", "description":"Specifies whether the fund has allocations.", "exampleSetFlag":false, "types":[ "boolean" ] }, "appropriationType":{ "type":"string", "description":"The type of appropriation.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "MANUAL", "FROM_ALLOCATION" ] }, "consumptionType":{ "type":"string", "description":"The type of consumption.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "NONE", "MANUAL", "FROM_ALLOCATION", "FROM_ACTUAL" ] }, "fundCost":{ "description":"Defines the fund cost of a fund.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFundCostInput" } ] }, "spreadRows":{ "type":"array", "description":"Defines the spread rows for a fund.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundSpreadRowInput", "exampleSetFlag":false }, "types":[ "array" ] }, "parentFundId":{ "type":"integer", "description":"The unique identification code of the parent fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentWorkspaceId":{ "type":"integer", "description":"The user-specified identifier of a workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "parentWorkspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "fundName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the fund.", "exampleSetFlag":false, "types":[ "string" ] }, "fundCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identification code of the fund.", "exampleSetFlag":false, "types":[ "string" ] }, "fundStatus":{ "type":"string", "description":"Either Active or Inactive. Inactive funds cannot be allocated or appropriated. They can only be consumed for projects or programs.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVE", "INACTIVE" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "startDate":{ "type":"string", "description":"The date when money in the fund will start being available.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programCode":{ "maxLength":60, "type":"string", "description":"The user-specified unique identifier of a program.", "exampleSetFlag":false, "types":[ "string" ] }, "configuredFields":{ "type":"array", "description":"The list of configured fields for a fund.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundConfiguredFieldValueInput", "exampleSetFlag":false }, "types":[ "array" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "programId":{ "type":"integer", "description":"The system-generated unique identifier of a program.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "endDate":{ "type":"string", "description":"The date when money in the fund will no longer be available.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "fundId":{ "type":"integer", "description":"The system generated identifier of a fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityFundSpreadRowInput":{ "title":"ApiEntityFundSpreadRowInput", "type":"object", "properties":{ "month":{ "type":"string", "description":"The time period during which funding takes place in months.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "fundAllocationSpreadRows":{ "type":"array", "description":"Defines the spread rows for a fund allocation.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityFundAllocationSpreadRowInput", "exampleSetFlag":false }, "types":[ "array" ] }, "fundSpreadRowId":{ "type":"integer", "description":"The unique identification code of the spread row.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundSpreadRowCost":{ "description":"Defines the cost associated with the spread rows of the fund.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFundCostSpreadRowInput" } ] }, "fundId":{ "type":"integer", "description":"The system generated identifier of a fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] } }, "exampleSetFlag":false }, "ApiEntityFundTotal":{ "title":"ApiEntityFundTotal", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "type":{ "type":"string", "description":"The Type value specifies whether the fund total is of the Type Portfolio, Program, Project, or Workspace.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE", "PROJECT", "PORTFOLIO" ] }, "fundTotalId":{ "type":"integer", "description":"The auto-generated sequence number for the Fund Total.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "fundTotalItemCost":{ "description":"The Cost value for the Fund Total Item.", "exampleSetFlag":false, "allOf":[ { "$ref":"#/components/schemas/ApiEntityFundTotalItemCost" } ] }, "capitalPortfolioId":{ "type":"integer", "description":"The system-generated unique identifier for Portfolio Fund.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "sourceId":{ "type":"integer", "description":"The unique identifier for the source of the fund. This could be Portfolio, Program, Project, or Workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityFundTotalItemCost":{ "title":"ApiEntityFundTotalItemCost", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "remaining":{ "type":"number", "description":"The portion of all funds in the workspace that has not been consumed.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace1":{ "type":"number", "description":"The portion of all funds in the workspace that has not yet been committed to actual work. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace2":{ "type":"number", "description":"The portion of all funds in the workspace that has not yet been committed to actual work. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unappropriatedWorkspace3":{ "type":"number", "description":"The portion of all funds in the workspace that has not yet been committed to actual work. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "fundTotalItemId":{ "type":"integer", "description":"The auto-generated sequence number for the Fund Total.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "unallocated":{ "type":"number", "description":"The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces.", "format":"double", "exampleSetFlag":false }, "unallocatedWorkspace1":{ "type":"number", "description":"The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "unallocatedWorkspace2":{ "type":"number", "description":"The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "unallocatedWorkspace3":{ "type":"number", "description":"The portion of all funds in the workspace that has not been reserved for work on projects, programs or other workspaces. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "appropriated":{ "type":"number", "description":"The portion of all funds in the workspace that has been committed to work on projects or programs.", "format":"double", "exampleSetFlag":false }, "unappropriated":{ "type":"number", "description":"The portion of all funds in the workspace that has not yet been committed to actual work.", "format":"double", "exampleSetFlag":false }, "consumed":{ "type":"number", "description":"The portion of all funds in the workspace that has been spent to complete work on projects or programs.", "format":"double", "exampleSetFlag":false }, "allocated":{ "type":"number", "description":"The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace1":{ "type":"number", "description":"The portion of all funds in the workspace that has been committed to work on projects or programs. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace2":{ "type":"number", "description":"The portion of all funds in the workspace that has been committed to work on projects or programs. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "appropriatedWorkspace3":{ "type":"number", "description":"The portion of all funds in the workspace that has been committed to work on projects or programs. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace1":{ "type":"number", "description":"The portion of all funds in the workspace that has been spent to complete work on projects or programs. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace2":{ "type":"number", "description":"The portion of all funds in the workspace that has been spent to complete work on projects or programs. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "consumedWorkspace3":{ "type":"number", "description":"The portion of all funds in the workspace that has been spent to complete work on projects or programs. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace1":{ "type":"number", "description":"The portion of all funds in the workspace that has not been consumed. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace2":{ "type":"number", "description":"The portion of all funds in the workspace that has not been consumed. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "remainingWorkspace3":{ "type":"number", "description":"The portion of all funds in the workspace that has not been consumed. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace1":{ "type":"number", "description":"The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace2":{ "type":"number", "description":"The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "allocatedWorkspace3":{ "type":"number", "description":"The portion of all funds in the workspace that has been reserved for work on projects, programs and other workspaces. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace1":{ "type":"number", "description":"The total amount of money granted for funds in the workspace. This value is based on the workspace1 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace2":{ "type":"number", "description":"The total amount of money granted for funds in the workspace. This value is based on the workspace2 currency.", "format":"double", "exampleSetFlag":false }, "totalWorkspace3":{ "type":"number", "description":"The total amount of money granted for funds in the workspace. This value is based on the workspace3 currency.", "format":"double", "exampleSetFlag":false }, "total":{ "type":"number", "description":"The total amount of money granted for funds in the workspace.", "format":"double", "exampleSetFlag":false }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMeasure":{ "title":"ApiEntityMeasure", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "granularity":{ "type":"string", "description":"The level of granularity for the measure.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ] }, "description":{ "maxLength":4000, "type":"string", "description":"The detailed summary providing additional information about the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "targetExpression":{ "maxLength":4000, "type":"string", "description":"The expression that is defined to capture the target value of a measure.", "exampleSetFlag":false, "types":[ "string" ] }, "measureDataType":{ "type":"string", "description":"Determines the type of data needed for the measure's value.
                                                                                                                                                                                                                                                                                                                                              Valid values are: Number, Cost, and Percentage.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PERCENTAGE", "COST", "BOOLEAN", "NUMBER" ] }, "actualBaseExpression":{ "maxLength":4000, "type":"string", "description":"The expression that calculates the base value for when the data type of a measure is set to Percentage.
                                                                                                                                                                                                                                                                                                                                              For example, if a measure is calculating the percentage of projects in a portfolio where the schedule variance is less than 10, the Base Expression would calculate the number of projects in the portfolio. The Base Expression would be: count(object.Project_projectCode).", "exampleSetFlag":false, "types":[ "string" ] }, "targetAggregationType":{ "type":"string", "description":"Determines the type of expression and provides the format for the selected type.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "PERCENT", "NONE" ] }, "measureBasedFlag":{ "type":"boolean", "description":"Determines whether the expression for the measure is based on project attributes or on other measures.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualType":{ "type":"string", "description":"Determines whether the Actual value of the measure is manually entered or calculated using a formula.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "FORMULA", "BUILTIN" ] }, "targetBaseExpression":{ "maxLength":4000, "type":"string", "description":"The expression that calculates the base value for when the data type of a measure is set to Percentage.
                                                                                                                                                                                                                                                                                                                                              For example, if a measure is calculating the percentage of projects in a portfolio where the schedule variance is less than 10, the Base Expression would calculate the number of projects in the portfolio. The Base Expression would be: count(object.Project_projectCode).", "exampleSetFlag":false, "types":[ "string" ] }, "actualExpression":{ "maxLength":4000, "type":"string", "description":"The expression that is defined to capture the actual value of a measure.", "exampleSetFlag":false, "types":[ "string" ] }, "actualAggregationType":{ "type":"string", "description":"Determines the type of aggregation to use in defining the expression. Valid values are Sum, Average, Max, Min, or Count.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "PERCENT", "NONE" ] }, "measureSourceType":{ "type":"string", "description":"Determines the type of entity the values are aggregated from.For example, for Activity as the measure source type, measure will aggregate activities' data.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "PROGRAM", "PROJECT", "RISK" ] }, "measureEntityType":{ "type":"string", "description":"Determines the type of entity the values are created under.For example, for PROJECT as the measure entity type, measure will shown under projects' measures page.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE", "PROJECT", "PROGRAM" ] }, "periodId":{ "type":"integer", "description":"The unique identifier of a default period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "enabledFlag":{ "type":"boolean", "description":"The state of the measure.
                                                                                                                                                                                                                                                                                                                                              Enabled: The measure can be associated with portfolios for monitoring.
                                                                                                                                                                                                                                                                                                                                              Disabled: This measure cannot be used for monitoring portfolios.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"It describes how data is shared between parent and child workspaces.
                                                                                                                                                                                                                                                                                                                                              Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                                                                                                                                                                                                                              Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "associationType":{ "type":"string", "description":"The type of association in the relationship between the measure and the workspace. Possible values are Owned and Inherited.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "OWNED", "INHERITED" ] }, "targetType":{ "type":"string", "description":"Determines whether the Target value of the measure is manually entered or calculated using a formula.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "FORMULA", "BUILTIN" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMeasureInput":{ "title":"ApiEntityMeasureInput", "required":[ "actualType", "enabledFlag", "granularity", "measureBasedFlag", "measureDataType", "measureName", "measureSourceType", "targetType", "workspaceId" ], "type":"object", "properties":{ "granularity":{ "type":"string", "description":"The level of granularity for the measure.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ] }, "description":{ "maxLength":4000, "type":"string", "description":"The detailed summary providing additional information about the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "targetExpression":{ "maxLength":4000, "type":"string", "description":"The expression that is defined to capture the target value of a measure.", "exampleSetFlag":false, "types":[ "string" ] }, "measureDataType":{ "type":"string", "description":"Determines the type of data needed for the measure's value.
                                                                                                                                                                                                                                                                                                                                              Valid values are: Number, Cost, and Percentage.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "PERCENTAGE", "COST", "BOOLEAN", "NUMBER" ] }, "actualBaseExpression":{ "maxLength":4000, "type":"string", "description":"The expression that calculates the base value for when the data type of a measure is set to Percentage.
                                                                                                                                                                                                                                                                                                                                              For example, if a measure is calculating the percentage of projects in a portfolio where the schedule variance is less than 10, the Base Expression would calculate the number of projects in the portfolio. The Base Expression would be: count(object.Project_projectCode).", "exampleSetFlag":false, "types":[ "string" ] }, "targetAggregationType":{ "type":"string", "description":"Determines the type of expression and provides the format for the selected type.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "PERCENT", "NONE" ] }, "measureBasedFlag":{ "type":"boolean", "description":"Determines whether the expression for the measure is based on project attributes or on other measures.", "exampleSetFlag":false, "types":[ "boolean" ] }, "actualType":{ "type":"string", "description":"Determines whether the Actual value of the measure is manually entered or calculated using a formula.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "FORMULA", "BUILTIN" ] }, "targetBaseExpression":{ "maxLength":4000, "type":"string", "description":"The expression that calculates the base value for when the data type of a measure is set to Percentage.
                                                                                                                                                                                                                                                                                                                                              For example, if a measure is calculating the percentage of projects in a portfolio where the schedule variance is less than 10, the Base Expression would calculate the number of projects in the portfolio. The Base Expression would be: count(object.Project_projectCode).", "exampleSetFlag":false, "types":[ "string" ] }, "actualExpression":{ "maxLength":4000, "type":"string", "description":"The expression that is defined to capture the actual value of a measure.", "exampleSetFlag":false, "types":[ "string" ] }, "actualAggregationType":{ "type":"string", "description":"Determines the type of aggregation to use in defining the expression. Valid values are Sum, Average, Max, Min, or Count.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "PERCENT", "NONE" ] }, "measureSourceType":{ "type":"string", "description":"Determines the type of entity the values are aggregated from.For example, for Activity as the measure source type, measure will aggregate activities' data.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTIVITY", "PROGRAM", "PROJECT", "RISK" ] }, "measureEntityType":{ "type":"string", "description":"Determines the type of entity the values are created under.For example, for PROJECT as the measure entity type, measure will shown under projects' measures page.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "WORKSPACE", "PROJECT", "PROGRAM" ] }, "periodId":{ "type":"integer", "description":"The unique identifier of a default period.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "enabledFlag":{ "type":"boolean", "description":"The state of the measure.
                                                                                                                                                                                                                                                                                                                                              Enabled: The measure can be associated with portfolios for monitoring.
                                                                                                                                                                                                                                                                                                                                              Disabled: This measure cannot be used for monitoring portfolios.", "exampleSetFlag":false, "types":[ "boolean" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"It describes how data is shared between parent and child workspaces.
                                                                                                                                                                                                                                                                                                                                              Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                                                                                                                                                                                                                              Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] }, "targetType":{ "type":"string", "description":"Determines whether the Target value of the measure is manually entered or calculated using a formula.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "FORMULA", "BUILTIN" ] } }, "description":"This entity represents a Measure object, a unique Measure object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                              • measureId
                                                                                                                                                                                                                                                                                                                                              • measureName,workspaceId
                                                                                                                                                                                                                                                                                                                                              • measureName,workspaceCode
                                                                                                                                                                                                                                                                                                                                                • ", "exampleSetFlag":false }, "ApiEntityMeasureThreshold":{ "title":"ApiEntityMeasureThreshold", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The unique identifier for the measure.The measure object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "measureThresholdItems":{ "type":"array", "description":"The items that define the threshold for the measure.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureThresholdItem", "exampleSetFlag":false }, "types":[ "array" ] }, "measureThresholdId":{ "type":"integer", "description":"The unique identifier of a threshold. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "computeAgainstType":{ "type":"string", "description":"The against type of a threshold.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTUAL_VALUE", "PERCENT_OF_TARGET" ] }, "desirableState":{ "type":"string", "description":"The type of direction of a threshold.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HIGH_VALUES", "LOW_VALUES" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMeasureThresholdItem":{ "title":"ApiEntityMeasureThresholdItem", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "color":{ "maxLength":20, "type":"string", "description":"The color representation of the threshold state.", "exampleSetFlag":false, "types":[ "string" ] }, "thresholdItemId":{ "type":"integer", "description":"The unique identifier of a threshold item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "operator":{ "type":"string", "description":"The logical operator for the threshold used for measuring values.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EQUALS", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN_EQUALS", "NOT_EQUALS", "LESS_THAN", "BETWEEN", "NOT_BETWEEN" ] }, "targetHighValue":{ "type":"number", "description":"High Value enables you to set a maximum value other threshold values can be measured against.
                                                                                                                                                                                                                                                                                                                                                The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\".", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetValue":{ "type":"number", "description":"The measurement used for the threshold range.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "measureThresholdId":{ "type":"integer", "description":"The unique identifier of a threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "icon":{ "type":"string", "description":"The pictorial representation of the threshold state.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "THREE_D", "CHECK", "CIRCLE", "CONTENT", "CORRECT", "DIAMOND", "ERROR", "EXCLAMATION", "FLAG", "HAPPY", "OK", "POP_UP", "SAD", "SQUARE", "STAR", "TARGET", "TRIANGLE", "WARNING", "X" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityMeasureThresholdInput":{ "title":"ApiEntityMeasureThresholdInput", "required":[ "computeAgainstType", "desirableState", "measureId" ], "type":"object", "properties":{ "measureId":{ "type":"integer", "description":"The unique identifier for the measure.The measure object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "measureThresholdItems":{ "type":"array", "description":"The items that define the threshold for the measure.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityMeasureThresholdItemInput", "exampleSetFlag":false }, "types":[ "array" ] }, "measureThresholdId":{ "type":"integer", "description":"The unique identifier of a threshold. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "computeAgainstType":{ "type":"string", "description":"The against type of a threshold.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "ACTUAL_VALUE", "PERCENT_OF_TARGET" ] }, "desirableState":{ "type":"string", "description":"The type of direction of a threshold.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "HIGH_VALUES", "LOW_VALUES" ] } }, "description":"This entity represents a MeasureThreshold object, a unique MeasureThreshold object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                                • measureThresholdId
                                                                                                                                                                                                                                                                                                                                                • computeAgainstType,desirableState,measureId
                                                                                                                                                                                                                                                                                                                                                • computeAgainstType,desirableState,measureName,workspaceCode
                                                                                                                                                                                                                                                                                                                                                  • ", "exampleSetFlag":false }, "ApiEntityMeasureThresholdItemInput":{ "title":"ApiEntityMeasureThresholdItemInput", "required":[ "measureThresholdId", "operator", "targetValue" ], "type":"object", "properties":{ "color":{ "maxLength":20, "type":"string", "description":"The color representation of the threshold state.", "exampleSetFlag":false, "types":[ "string" ] }, "thresholdItemId":{ "type":"integer", "description":"The unique identifier of a threshold item.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "operator":{ "type":"string", "description":"The logical operator for the threshold used for measuring values.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "EQUALS", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN_EQUALS", "NOT_EQUALS", "LESS_THAN", "BETWEEN", "NOT_BETWEEN" ] }, "targetHighValue":{ "type":"number", "description":"High Value enables you to set a maximum value other threshold values can be measured against.
                                                                                                                                                                                                                                                                                                                                                  The High Value is only editable if Value is selected and the threshold operator is set to \"within range\" or \"not within range\".", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetValue":{ "type":"number", "description":"The measurement used for the threshold range.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "measureThresholdId":{ "type":"integer", "description":"The unique identifier of a threshold.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "icon":{ "type":"string", "description":"The pictorial representation of the threshold state.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "THREE_D", "CHECK", "CIRCLE", "CONTENT", "CORRECT", "DIAMOND", "ERROR", "EXCLAMATION", "FLAG", "HAPPY", "OK", "POP_UP", "SAD", "SQUARE", "STAR", "TARGET", "TRIANGLE", "WARNING", "X" ] } }, "exampleSetFlag":false }, "ApiEntityOfficeInput":{ "title":"ApiEntityOfficeInput", "required":[ "cityName", "companyId", "officeCountryCode", "officeName", "officePostalCode", "stateName" ], "type":"object", "properties":{ "officeName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the office.", "exampleSetFlag":false, "types":[ "string" ] }, "isCorporateOffice":{ "type":"boolean", "description":"Indicates if the office is the headquarters of the company.", "exampleSetFlag":false, "types":[ "boolean" ] }, "orgOfficeId":{ "type":"integer", "description":"The unique identifier of the organization of the office.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "longitude":{ "maximum":180, "minimum":-180, "type":"number", "description":"The geographical coordinate for the longitude of the location.
                                                                                                                                                                                                                                                                                                                                                  The default format for longitude is decimal degrees, but the format you need to use will depend on your geolocation service.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "latitude":{ "maximum":90, "minimum":-90, "type":"number", "description":"The geographical coordinate for the latitude of the location.
                                                                                                                                                                                                                                                                                                                                                  The default format for latitude is decimal degrees, but the format you need to use will depend on your geolocation service.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "countryCode":{ "maxLength":3, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "distance":{ "type":"number", "description":"The distance the company is willing to travel for the project from this office.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "distanceMetric":{ "type":"string", "description":"The distance measure to be used. Valid options include kilometer and mile.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "KILOMETERS", "MILES" ] }, "officeId":{ "type":"integer", "description":"The unique identifier of an office.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyId":{ "type":"integer", "description":"The unique identifier for the company.The company object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "officeCountryCode":{ "maxLength":200, "minLength":0, "type":"string", "description":"The country for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "officePostalCode":{ "maxLength":200, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine1":{ "maxLength":200, "type":"string", "description":"The first line of the address of a location.
                                                                                                                                                                                                                                                                                                                                                  This might be the building number and street address.", "exampleSetFlag":false, "types":[ "string" ] }, "addressLine2":{ "maxLength":200, "type":"string", "description":"The second line of the address of a location.
                                                                                                                                                                                                                                                                                                                                                  This might be a neighborhood or town.", "exampleSetFlag":false, "types":[ "string" ] }, "cityName":{ "maxLength":200, "type":"string", "description":"The name of the city for a location.", "exampleSetFlag":false, "types":[ "string" ] }, "stateName":{ "maxLength":200, "type":"string", "description":"The state, region, or province of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "fax":{ "maxLength":32, "type":"string", "description":"The fax number for the office.", "exampleSetFlag":false, "types":[ "string" ] }, "phone":{ "maxLength":32, "type":"string", "description":"The phone number for the office.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a Office object, a unique Office object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                                  • officeId
                                                                                                                                                                                                                                                                                                                                                  • officeName,companyId
                                                                                                                                                                                                                                                                                                                                                  • officeName,companyName,postalCode,countryCode
                                                                                                                                                                                                                                                                                                                                                    • ", "exampleSetFlag":false }, "ApiEntityPortfolioMeasure":{ "title":"ApiEntityPortfolioMeasure", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioMeasureId":{ "type":"integer", "description":"The unique identifier of a portfolio measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a portfolio measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "lastCalculatedDate":{ "type":"string", "description":"The date on which the measure was last calculated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "enabledFlag":{ "type":"boolean", "description":"Indicates the state of the measure. Enabled measures can be associated with portfolios.", "exampleSetFlag":false, "types":[ "boolean" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioMeasureInput":{ "title":"ApiEntityPortfolioMeasureInput", "required":[ "enabledFlag", "measureId", "portfolioId" ], "type":"object", "properties":{ "portfolioMeasureId":{ "type":"integer", "description":"The unique identifier of a portfolio measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a portfolio measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioId":{ "type":"integer", "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "lastCalculatedDate":{ "type":"string", "description":"The date on which the measure was last calculated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "enabledFlag":{ "type":"boolean", "description":"Indicates the state of the measure. Enabled measures can be associated with portfolios.", "exampleSetFlag":false, "types":[ "boolean" ] } }, "description":"This entity represents a PortfolioMeasure object, a unique PortfolioMeasure object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                                    • portfolioMeasureId
                                                                                                                                                                                                                                                                                                                                                    • measureId,portfolioId
                                                                                                                                                                                                                                                                                                                                                    • measureName,portfolioId,workspaceCode
                                                                                                                                                                                                                                                                                                                                                    • measureName,portfolioName,workspaceCode
                                                                                                                                                                                                                                                                                                                                                    • measureId,portfolioName,workspaceCode
                                                                                                                                                                                                                                                                                                                                                      • ", "exampleSetFlag":false }, "ApiEntityPortfolioMeasureValue":{ "title":"ApiEntityPortfolioMeasureValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The unique identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "portfolioMeasureValueId":{ "type":"integer", "description":"The unique identifier of a portfolio.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "varDerivedValue":{ "type":"number", "description":"The variance for a measure value associated with a portfolio. Calculated as actual value minus target value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "varBaseValue":{ "type":"number", "description":"The variance for a measure base value associated with a portfolio.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualDerivedValue":{ "type":"number", "description":"The actual value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "varExpressionValue":{ "type":"number", "description":"The expression value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetBaseValue":{ "type":"number", "description":"The base target value for a measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "entryType":{ "type":"string", "description":"The type of a measure entry.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COMPUTE" ] }, "targetDerivedValue":{ "type":"number", "description":"The target value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetExpressionValue":{ "type":"number", "description":"The target value for the measure.
                                                                                                                                                                                                                                                                                                                                                      If the measure is set manually, the current period's target value displays.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualBaseValue":{ "type":"number", "description":"The base actual value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualExpressionValue":{ "type":"number", "description":"The actual value for the measure.
                                                                                                                                                                                                                                                                                                                                                      If the measure is set manually, the current period's actual value displays.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "lastCalculatedDate":{ "type":"string", "description":"The date on which a measure was last calculated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "readOnly":true, "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioMeasureManualValue":{ "title":"ApiEntityPortfolioMeasureManualValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioMeasureManualValueId":{ "type":"integer", "description":"The unique identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "beginDate":{ "type":"string", "description":"The start date of a portfolio.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "endDate":{ "type":"string", "description":"The end date of the portfolio.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "targetValue":{ "type":"number", "description":"The target value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualValue":{ "type":"number", "description":"The actual value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "varValue":{ "type":"number", "description":"The variance of a portfolio.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityPortfolioMeasureManualValueInput":{ "title":"ApiEntityPortfolioMeasureManualValueInput", "required":[ "beginDate", "capitalPortfolioId", "endDate", "measureId" ], "type":"object", "properties":{ "portfolioMeasureManualValueId":{ "type":"integer", "description":"The unique identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "capitalPortfolioId":{ "type":"integer", "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "beginDate":{ "type":"string", "description":"The start date of a portfolio.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "measureName":{ "maxLength":255, "type":"string", "description":"The name of the measure.", "exampleSetFlag":false, "types":[ "string" ] }, "portfolioName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the portfolio.", "exampleSetFlag":false, "types":[ "string" ] }, "endDate":{ "type":"string", "description":"The end date of the portfolio.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "targetValue":{ "type":"number", "description":"The target value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualValue":{ "type":"number", "description":"The actual value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "varValue":{ "type":"number", "description":"The variance of a portfolio.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] } }, "description":"This entity represents a PortfolioMeasureManualValue object, a unique PortfolioMeasureManualValue object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                                      • portfolioMeasureManualValueId
                                                                                                                                                                                                                                                                                                                                                      • measureId,capitalPortfolioId,beginDate,endDate
                                                                                                                                                                                                                                                                                                                                                      • measureName,capitalPortfolioId,beginDate,endDate,workspaceCode
                                                                                                                                                                                                                                                                                                                                                      • measureId,portfolioName,beginDate,endDate,workspaceCode
                                                                                                                                                                                                                                                                                                                                                      • measureName,portfolioName,beginDate,endDate,workspaceCode
                                                                                                                                                                                                                                                                                                                                                        • ", "exampleSetFlag":false }, "ApiEntityProjectCompany":{ "title":"ApiEntityProjectCompany", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The system-generated unique identifier of the project company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyId":{ "type":"integer", "description":"The unique identifier for the company.The company object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "color":{ "maxLength":6, "minLength":1, "type":"string", "description":"The selected color representation of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityProjectCompanyInput":{ "title":"ApiEntityProjectCompanyInput", "required":[ "color", "companyId", "projectId" ], "type":"object", "properties":{ "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "postalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The system-generated unique identifier of the project company.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyId":{ "type":"integer", "description":"The unique identifier for the company.The company object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "color":{ "maxLength":6, "minLength":1, "type":"string", "description":"The selected color representation of the company.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ProjectCompany object, a unique ProjectCompany object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                                        • projectCompanyId
                                                                                                                                                                                                                                                                                                                                                        • projectId,companyId
                                                                                                                                                                                                                                                                                                                                                        • companyId,projectCode,workspaceCode
                                                                                                                                                                                                                                                                                                                                                        • companyName,postalCode,projectId
                                                                                                                                                                                                                                                                                                                                                        • companyName,postalCode,projectCode,workspaceCode
                                                                                                                                                                                                                                                                                                                                                          • ", "exampleSetFlag":false }, "ApiEntityProjectMeasureValue":{ "title":"ApiEntityProjectMeasureValue", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "projectMeasureValueId":{ "type":"integer", "description":"The unique identifier of a project measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "varDerivedValue":{ "type":"number", "description":"The variance for a measure value associated with a project. Calculated as actual value minus target value.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "varBaseValue":{ "type":"number", "description":"The variance for a measure base value associated with a portfolio.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualDerivedValue":{ "type":"number", "description":"The actual value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "varExpressionValue":{ "type":"number", "description":"The expression value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetBaseValue":{ "type":"number", "description":"The base target value for a measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetDerivedValue":{ "type":"number", "description":"The target value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "targetExpressionValue":{ "type":"number", "description":"The target value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualBaseValue":{ "type":"number", "description":"The base actual value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "actualExpressionValue":{ "type":"number", "description":"The actual expression value for the measure.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "measureEntryType":{ "type":"string", "description":"The type of a measure entry.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "COMPUTE" ] }, "lastCalculatedDate":{ "type":"string", "description":"The date on which the measure was last calculated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] }, "measureId":{ "type":"integer", "description":"The unique identifier of a measure.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectId":{ "type":"integer", "description":"The unique identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityReasonInput":{ "title":"ApiEntityReasonInput", "required":[ "abbreviation", "reasonName", "workspaceId" ], "type":"object", "properties":{ "reasonId":{ "type":"integer", "description":"The unique identifier of a reason.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reasonName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the reason for recommitting to a task.", "exampleSetFlag":false, "types":[ "string" ] }, "abbreviation":{ "maxLength":60, "minLength":1, "type":"string", "description":"The abbreviation of the reason for recommitting to a task.", "exampleSetFlag":false, "types":[ "string" ] }, "appliesTo":{ "type":"array", "description":"Indicates the type of object the reason is associated to. ", "exampleSetFlag":false, "items":{ "type":"string", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "TASKS", "CHANGE_EVENT" ] }, "types":[ "array" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceId":{ "type":"integer", "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "pushDownType":{ "type":"string", "description":"How data is shared between parent and child workspaces.
                                                                                                                                                                                                                                                                                                                                                          Manual: Data can be pulled down by child workspaces. This is the default option.
                                                                                                                                                                                                                                                                                                                                                          Automatic: Data is automatically shared with all child workspaces.", "exampleSetFlag":false, "types":[ "string" ], "enum":[ "MANUAL", "AUTOMATIC" ] } }, "description":"This entity represents a Reason object, a unique Reason object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                                          • reasonId
                                                                                                                                                                                                                                                                                                                                                          • reasonName,workspaceId
                                                                                                                                                                                                                                                                                                                                                          • reasonName,workspaceCode
                                                                                                                                                                                                                                                                                                                                                            • ", "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentActivity":{ "title":"ApiEntityScopeItemAssignmentActivity", "type":"object", "properties":{ "link":{ "type":"string", "description":"The self-link to the object. This field is populated only in the responses generated by the batch create APIs.", "format":"url", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentActivityId":{ "type":"integer", "description":"The system-generated identifier of an activity. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of the scope assignment that is linked to the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manualWeightFactor":{ "type":"number", "description":"The value used to calculate manual completed weight when progress needs to be weighted against a factor other than quantity, hours, or cost.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "manualWeight":{ "type":"number", "description":"Calculated as Scope Percent Complete multiplied by Manual Weight.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scopeItemAssignmentCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The system-generated identifier of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] }, "updateDate":{ "type":"string", "description":"Date when the record was last updated.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "exampleSetFlag":false }, "ApiEntityScopeItemAssignmentActivityInput":{ "title":"ApiEntityScopeItemAssignmentActivityInput", "required":[ "activityId", "scopeItemAssignmentId" ], "type":"object", "properties":{ "scopeItemAssignmentActivityId":{ "type":"integer", "description":"The system-generated identifier of an activity. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "scopeItemCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope item.", "exampleSetFlag":false, "types":[ "string" ] }, "workPackageCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for the work package.", "exampleSetFlag":false, "types":[ "string" ] }, "scopeItemAssignmentId":{ "type":"integer", "description":"The unique identifier of the scope assignment that is linked to the activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "manualWeightFactor":{ "type":"number", "description":"The value used to calculate manual completed weight when progress needs to be weighted against a factor other than quantity, hours, or cost.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "manualWeight":{ "type":"number", "description":"Calculated as Scope Percent Complete multiplied by Manual Weight.", "format":"double", "exampleSetFlag":false, "types":[ "number" ] }, "scopeItemAssignmentCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier for the scope assignment.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "activityId":{ "type":"integer", "description":"The system-generated identifier of an activity.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "activityCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of the activity.", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a ScopeItemAssignmentActivity object, a unique ScopeItemAssignmentActivity object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                                            • scopeItemAssignmentActivityId
                                                                                                                                                                                                                                                                                                                                                            • activityId,scopeItemAssignmentId
                                                                                                                                                                                                                                                                                                                                                            • activityId,projectCode,workspaceCode,scopeItemCode,workPackageCode,scopeItemAssignmentCode
                                                                                                                                                                                                                                                                                                                                                            • activityCode,projectCode,workspaceCode,scopeItemCode,workPackageCode,scopeItemAssignmentCode
                                                                                                                                                                                                                                                                                                                                                              • ", "exampleSetFlag":false }, "ApiEntityWorkManagerTaskCommitmentInput":{ "title":"ApiEntityWorkManagerTaskCommitmentInput", "required":[ "dueDate", "projectCompanyId", "projectId", "workManagerTaskId" ], "type":"object", "properties":{ "workManagerTaskCommitmentId":{ "type":"integer", "description":"The unique identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "workManagerTaskCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The user-specified unique identifier assigned to the task.", "exampleSetFlag":false, "types":[ "string" ] }, "comments":{ "maxLength":4000, "minLength":1, "type":"string", "description":"The comments captured with a task commitment.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyId":{ "type":"integer", "description":"The system-generated identifier of a project.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "companyName":{ "maxLength":255, "minLength":1, "type":"string", "description":"The name of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "companyPostalCode":{ "maxLength":20, "minLength":0, "type":"string", "description":"The postal code, post code, or zip code of a location.", "exampleSetFlag":false, "types":[ "string" ] }, "projectCompanyColor":{ "maxLength":6, "minLength":1, "type":"string", "description":"The selected color representation of the company.", "exampleSetFlag":false, "types":[ "string" ] }, "workManagerTaskId":{ "type":"integer", "description":"The unique identifier for the work manager task.The work manager task object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "projectCode":{ "maxLength":60, "minLength":1, "type":"string", "description":"The unique identifier for a project set by the user who created the project.", "exampleSetFlag":false, "types":[ "string" ] }, "workspaceCode":{ "maxLength":60, "minLength":0, "type":"string", "description":"The user-specified identifier of a workspace.", "exampleSetFlag":false, "types":[ "string" ] }, "projectId":{ "type":"integer", "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.", "format":"int64", "exampleSetFlag":false, "types":[ "integer" ] }, "reasons":{ "type":"array", "description":"The reasons of a work manager task commitment.", "exampleSetFlag":false, "items":{ "$ref":"#/components/schemas/ApiEntityReasonInput", "exampleSetFlag":false }, "types":[ "array" ] }, "dueDate":{ "type":"string", "description":"The date by which the task is expected to be completed.", "format":"date-time", "exampleSetFlag":false, "types":[ "string" ] } }, "description":"This entity represents a WorkManagerTaskCommitment object, a unique WorkManagerTaskCommitment object can be identified by the following combinations of the fields.
                                                                                                                                                                                                                                                                                                                                                              • workManagerTaskCommitmentId
                                                                                                                                                                                                                                                                                                                                                              • dueDate,projectCompanyId,workManagerTaskId,projectId
                                                                                                                                                                                                                                                                                                                                                              • dueDate,projectCompanyId,workManagerTaskId,projectCode,workspaceCode
                                                                                                                                                                                                                                                                                                                                                              • dueDate,companyName,companyPostalCode,projectCompanyColor,workManagerTaskId,projectId
                                                                                                                                                                                                                                                                                                                                                              • dueDate,projectCompanyId,workManagerTaskCode,projectId
                                                                                                                                                                                                                                                                                                                                                              • dueDate,companyName,companyPostalCode,projectCompanyColor,workManagerTaskCode,projectCode,workspaceCode
                                                                                                                                                                                                                                                                                                                                                              • dueDate,projectCompanyId,workManagerTaskCode,projectCode,workspaceCode
                                                                                                                                                                                                                                                                                                                                                              • dueDate,companyName,companyPostalCode,projectCompanyColor,workManagerTaskCode,projectId
                                                                                                                                                                                                                                                                                                                                                              • dueDate,companyName,companyPostalCode,projectCompanyColor,workManagerTaskCode,projectCode,workspaceCode
                                                                                                                                                                                                                                                                                                                                                                • ", "exampleSetFlag":false } } } }