Oracle Prime Projects REST API

Root Schema : List<ApiEntityProjectRisk>

Type: array

Title: List<ApiEntityProjectRisk>

Show Source

[0]: object ApiEntityProjectRisk

{
    "title":"List<ApiEntityProjectRisk>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityProjectRisk"
    }
}

Nested Schema : ApiEntityProjectRisk

Type: object

Show Source

cause(optional): object RichTextString
cbsSheetCodeId(optional): integer(int64)

The cost breakdown structure code assigned to the risk.
codeValuesRisk(optional): array codeValuesRisk

Unique Items Required: true

The user-specified identifier of a risk.VALUES
costCategoryId(optional): integer(int64)

The category name used to organize and define the cost.
costImpactQuantified(optional): boolean

When selected, the quantified cost distribution is used to determine the cost impact for each iteration.
description(optional): object RichTextString
effect(optional): object RichTextString
hasPostResponseData(optional): boolean
identifiedById(optional): integer(int64)
identifiedDate(optional): string(date-time)
impacts(optional): array impacts

Unique Items Required: true
itemPrefix(optional): string

The auto numbering prefix of a code.
itemSuffix(optional): integer(int64)

The auto numbering suffix of a code.
link(optional): string(url)

Read Only: true
ownerId(optional): integer(int64)
postScore(optional): integer(int32)

The risk calculation based on the post-response values defined for probability, cost impact, schedule impact, and any additional user-defined impacts for the risk.
probabilityImpactQuantified(optional): boolean

When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.
project(optional): object ApiEntityProject
projectId(optional): integer(int64)
projectRiskConfiguredFields(optional): object ApiEntityProjectRiskConfiguredFields
projectRiskFinancial(optional): object ApiEntityProjectRiskFinancial
projectRiskId(optional): integer(int64)
quantifiedPostResponseProbabilityThreshold(optional): number(double)

The probability threshold that a risk will occur after implementing a response action.
quantifiedPostResponseScheduleThreshold(optional): number(double)

The estimated impact size that the risk will have on the project schedule after implementing a response action.
quantifiedProbabilityThreshold(optional): number(double)

The estimated probability that a risk will occur before implementing a response action.
quantifiedScheduleThreshold(optional): number(double)

The estimated impact size that the risk will have on the project schedule before implementing a response action.
riskCategory(optional): object ApiEntityRiskCategory
riskCategoryId(optional): integer(int64)

The unique identifier for the risk type.
riskCode(optional): string

The unique identifier for the risk.
riskName(optional): string

The name of the risk.
riskQuantifiedCostImpact(optional): object ApiEntityRiskQuantifiedCostImpact
riskQuantifiedOtherImpacts(optional): array riskQuantifiedOtherImpacts

Unique Items Required: true

The impact this risk will have on other data.
riskStatus(optional): string

Allowed Values: [ "PROPOSED", "OPEN", "ACTIVE", "REJECTED", "MANAGED", "IMPACTED" ]
riskType(optional): string

Allowed Values: [ "THREAT", "OPPORTUNITY" ]

The type of risk. Valid values are Threat and Opportunity.
scheduleImpactQuantified(optional): boolean

When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.
score(optional): integer(int32)

The risk calculation based on the pre-response values defined for probability, cost impact, schedule impact, and any additional user-defined impacts for the risk.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "cause":{
            "description":"A description of the cause of the risk.",
            "$ref":"#/definitions/RichTextString"
        },
        "description":{
            "description":"A detailed summary of the risk.",
            "$ref":"#/definitions/RichTextString"
        },
        "project":{
            "$ref":"#/definitions/ApiEntityProject"
        },
        "itemSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The auto numbering suffix of a code."
        },
        "itemPrefix":{
            "type":"string",
            "description":"The auto numbering prefix of a code."
        },
        "riskName":{
            "type":"string",
            "description":"The name of the risk."
        },
        "riskType":{
            "type":"string",
            "description":"The type of risk. Valid values are Threat and Opportunity.",
            "enum":[
                "THREAT",
                "OPPORTUNITY"
            ]
        },
        "riskStatus":{
            "type":"string",
            "enum":[
                "PROPOSED",
                "OPEN",
                "ACTIVE",
                "REJECTED",
                "MANAGED",
                "IMPACTED"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "format":"int64"
        },
        "impacts":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityRiskImpact"
            }
        },
        "score":{
            "type":"integer",
            "format":"int32",
            "description":"The risk calculation based on the pre-response values defined for probability, cost impact, schedule impact, and any additional user-defined impacts for the risk."
        },
        "postScore":{
            "type":"integer",
            "format":"int32",
            "description":"The risk calculation based on the post-response values defined for probability, cost impact, schedule impact, and any additional user-defined impacts for the risk."
        },
        "riskCategory":{
            "description":"",
            "$ref":"#/definitions/ApiEntityRiskCategory"
        },
        "effect":{
            "description":"The resulting effect of the presence of the risk.",
            "$ref":"#/definitions/RichTextString"
        },
        "riskCode":{
            "type":"string",
            "description":"The unique identifier for the risk."
        },
        "ownerId":{
            "type":"integer",
            "format":"int64",
            "description":""
        },
        "projectId":{
            "type":"integer",
            "format":"int64"
        },
        "costImpactQuantified":{
            "type":"boolean",
            "description":"When selected, the quantified cost distribution is used to determine the cost impact for each iteration."
        },
        "riskQuantifiedOtherImpacts":{
            "type":"array",
            "description":"The impact this risk will have on other data.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityRiskQuantifiedOtherImpact"
            }
        },
        "identifiedDate":{
            "type":"string",
            "format":"date-time",
            "description":""
        },
        "hasPostResponseData":{
            "type":"boolean"
        },
        "scheduleImpactQuantified":{
            "type":"boolean",
            "description":"When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration."
        },
        "projectRiskFinancial":{
            "description":"Project ID.",
            "$ref":"#/definitions/ApiEntityProjectRiskFinancial"
        },
        "quantifiedScheduleThreshold":{
            "type":"number",
            "format":"double",
            "description":"The estimated impact size that the risk will have on the project schedule before implementing a response action."
        },
        "probabilityImpactQuantified":{
            "type":"boolean",
            "description":"When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration."
        },
        "riskQuantifiedCostImpact":{
            "description":"The impact this risk will have on cost data.",
            "$ref":"#/definitions/ApiEntityRiskQuantifiedCostImpact"
        },
        "riskCategoryId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the risk type."
        },
        "identifiedById":{
            "type":"integer",
            "format":"int64",
            "description":""
        },
        "codeValuesRisk":{
            "type":"array",
            "description":"The user-specified identifier of a risk.VALUES",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeValueRisk"
            }
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The cost breakdown structure code assigned to the risk."
        },
        "costCategoryId":{
            "type":"integer",
            "format":"int64",
            "description":"The category name used to organize and define the cost."
        },
        "projectRiskConfiguredFields":{
            "description":"The configured fields of a project risk.",
            "$ref":"#/definitions/ApiEntityProjectRiskConfiguredFields"
        },
        "quantifiedPostResponseScheduleThreshold":{
            "type":"number",
            "format":"double",
            "description":"The estimated impact size that the risk will have on the project schedule after implementing a response action."
        },
        "quantifiedPostResponseProbabilityThreshold":{
            "type":"number",
            "format":"double",
            "description":"The probability threshold that a risk will occur after implementing a response action."
        },
        "quantifiedProbabilityThreshold":{
            "type":"number",
            "format":"double",
            "description":"The estimated probability that a risk will occur before implementing a response action."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : RichTextString

Type: object

Show Source

wrappedString(optional): string

{
    "type":"object",
    "properties":{
        "wrappedString":{
            "type":"string"
        }
    }
}

Nested Schema : codeValuesRisk

Type: array

Unique Items Required: true

The user-specified identifier of a risk.VALUES

Show Source

[0]: object ApiEntityCodeValueRisk

{
    "type":"array",
    "description":"The user-specified identifier of a risk.VALUES",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeValueRisk"
    }
}

Nested Schema : impacts

Type: array

Unique Items Required: true

Show Source

[0]: object ApiEntityRiskImpact

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityRiskImpact"
    }
}

Nested Schema : ApiEntityProject

Type: object

Show Source

actualDuration(optional): object Duration
actualFinish(optional): string(date-time)

The Actual Finish displays the date on which a project is considered complete.
This value can be entered manually or can be imported.
actualLinkType(optional): string

Allowed Values: [ "BUDGET", "UDF", "MANUAL", "ACTUAL", "ACT_P6" ]

The field source for the actuals curve in cash flow.
actualStart(optional): string(date-time)

The Actual Start indicates the date work on the project began.
This value can be entered manually or can be imported.
addressLine1(optional): string

The first line of the address of a location.
This might be the building number and street address.
addressLine2(optional): string

The second line of the address of a location.
This might be a neighborhood or town.
calendarId(optional): integer(int64)

The unique identifier for the calendar.
cityName(optional): string

The city name for a location.
codeValuesProject(optional): array codeValuesProject

Unique Items Required: true

The categories of a project.
copyFromProjectId(optional): integer(int64)

The system-generated identifier of the project this data was copied from.
countryCode(optional): string

The country for a location.
currentApprovedFinishDate(optional): string(date-time)

Read Only: true

The finish date for the Current Approved Budget set by the budget planner.
currentApprovedStartDate(optional): string(date-time)

Read Only: true

The start date for the Current Approved Budget set by the budget planner.
dataDate(optional): string(date-time)

The progress point, or "as-of date", for activities in the project. Project status is up-to-date as of the data date. You can set the data date when you schedule the project, or you can set it manually.
The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities.
description(optional): string

Allowed Values: [ "Length[1-4000]" ]

The detailed summary for the project.
The description provides more information than short names or titles.
It can give background information or establish a purpose for the item.
These details help differentiate between items with similar names and are especially useful in multi-user environments.
evaluationMatrixId(optional): integer(int64)

The evaluation matrix of a calendar.
evaluationScore(optional): object Percent
exchangeRateType(optional): string

Allowed Values: [ "FLOATING", "PEGGED" ]

The type of an exchange rate.
finishDate(optional): string(date-time)

The date on which all project work is complete.
This value can be entered manually or can be imported.
finishDateVariance(optional): object Duration
forecastFinishDate(optional): string(date-time)

The planned finish date of a project's remaining Forecast cost.
forecastLinkType(optional): string

Allowed Values: [ "BUDGET", "UDF", "MANUAL", "ACTUAL", "ACT_P6" ]

The field source for the forecast curve in cash flow.
forecastStartDate(optional): string(date-time)

The planned start date of a project's remaining Forecast cost.
image(optional): object ApiEntityProjectImage
isPSyncManaged(optional): boolean

Read Only: true

Indicates the project is synchronized with P6 EPPM.
isTemplateFlag(optional): boolean

Indicates the project is a template for creating other projects.
lastProjectEvaluationDate(optional): string(date-time)

The date on which the project was last evaluated.
latitude(optional): number(double)

The geographical coordinate for the latitude of the location.
The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
link(optional): string(url)

Read Only: true
linkActualTo(optional): integer(int64)

Specifies data to which project actuals data is linked.
linkForecastTo(optional): integer(int64)

Specifies data to which a project forecast is linked.
linkForecastToSpend(optional): boolean

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.
linkPlannedBudgetTo(optional): integer(int64)

Read Only: true

Specifies data to which a project planned budget is linked.
locationName(optional): string

A name for the location that your users will understand and recognize.
longitude(optional): number(double)

The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
manager(optional): string

The manager or person responsible for the project.
mustFinishByDate(optional): string(date-time)

The latest date on which the scheduled activities must be complete for a project.
parentProject(optional): integer(int64)

Read Only: true

The workspace the project is associated with.
pegRate(optional): number

The custom exchange rate for a pegged exchange rate.
percentComplete(optional): object Percent
percentCompleteWeightedBy(optional): string

Read Only: true

Allowed Values: [ "COST", "QUANTITY", "HOURS", "MANUAL" ]

The weight for scope items is calculated using quantity.
planDuration(optional): object Duration
planEndDate(optional): string(date-time)

The finish date for the time phased Planned Budget of the project.
Planned Budget cost spread will adjust when this date is changed.
plannedBudgetLinkType(optional): string

Allowed Values: [ "BUDGET", "UDF", "MANUAL", "ACTUAL", "ACT_P6" ]

The field source for the planned budget curve in cash flow.
planStartDate(optional): string(date-time)

The start date for the time phased Planned Budget of the project.
Planned Budget cost spread will adjust when this date is changed.
The Project Planned Start also represents the earliest date that activities can occur within a project schedule.
postalCode(optional): string

The postal code, post code, or zip code of a location.
priorityNum(optional): integer(int64)

The project's priority in the strategic plan.
This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data.
projectAutoNumber(optional): array projectAutoNumber

Read Only: true

Unique Items Required: true

The autonumber settings of a project.
projectCashFlows(optional): array projectCashFlows

The cash flow of a project.
projectCode: string

Allowed Values: [ "Length[1-60]" ]

The unique identifier for a project set by the user who created the project.
projectConfiguredFields(optional): object ApiEntityProjectConfiguredFields
projectCurrency(optional): integer(int64)

The unique identifier of a currency.
projectFinancial(optional): object ApiEntityProjectFinancial
projectId(optional): integer(int64)

The unique identifier for the project. This value should not be provided in create operation request data, however, it is required for update requests.
projectIntegrationType(optional): string

Allowed Values: [ "P6", "UNIFIER" ]

Specifies if the project is integrated with another application.
projectName: string

Allowed Values: [ "Length[1-255]" ]

The name of the project.
projectSettings(optional): array projectSettings

Read Only: true

Unique Items Required: true
proposedFinishDate(optional): string(date-time)

Read Only: true

The finish date for the Proposed Budget of the project.
proposedStartDate(optional): string(date-time)

Read Only: true

The start date for the Proposed Budget of the project.
recordCount(optional): integer(int32)

The number of comments on a project.
remainingDuration(optional): object Duration
reportCycleId(optional): integer(int64)

The reporting cycle assigned to the project.
reportCycleNamingBoundary(optional): string

Read Only: true

Allowed Values: [ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]

Determines when period names will be reset. The options available are based on the selection for Reporting Cycle. The standard calendar start and end dates are used as boundaries for resetting periods.
riskLevel(optional): string

Allowed Values: [ "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW", "NULL" ]

The risk level assigned to the project.
Projects can have a risk level of very high, high, medium, low, or very low.
You can use risk level to determine what projects should be included in your plans, as well as which projects should be of priority.
riskMatrixId(optional): integer(int64)

The risk matrix assigned to the project for calculating project risk scores.
riskScore(optional): integer(int32)

The risk score value is based on the probability and impacts of a risk. It is derived from the probability impact matrix and any associated rules.
scheduledFinishDate(optional): string(date-time)

The calculated latest early finish date, which is based on the schedule most recently generated for the project.
securityGuid(optional): string

Read Only: true

Globally unique identifier of a project.
sequenceNumber(optional): integer(int32)

Determines the order of appearance of projects in a list.
sourceId(optional): string

The unique identifier of a project in an external source.
spendEffectiveDate(optional): string(date-time)

Read Only: true

The month in which an actuals value was last added to the project.
spendFinishDate(optional): string(date-time)

Read Only: true

The finish date for the project actuals.
spendStartDate(optional): string(date-time)

Read Only: true

The start date for the project actuals.
startDate(optional): string(date-time)

The date on which work on the project starts.
This value can be entered manually or can be imported.
startDateVariance(optional): object Duration
stateCode(optional): string

A unique identifier for the state or province.
stateName(optional): string

The state, region, or province of a location.
status(optional): string

Allowed Values: [ "PROPOSAL", "REJECTED", "PLANNED", "ACTIVE", "INACTIVE", "COMPLETE" ]

The current status of a project.
Proposal: The project is a project proposal and has not been extensively planned nor accrued any costs.
Rejected: The project proposal has been rejected and will not be initiated as a project.
Planned: The project is currently planned for execution. Project managers input expected project costs and other project data during this stage.
Active: The project is currently active and being executed.
Inactive: The project has been rendered inactive and will temporarily accrue no costs.
Complete: The project has been successfully completed and will no longer accrue costs.
strgyPriorityNum(optional): integer(int64)

The project's priority in the strategic plan.
This priority value ranges from 1 to 10,000 with a default of 500. Use of the priority value, such as whether to place higher priority at the lower end of the scale, toward the endpoint 1, or at the higher end, toward 10,000, is at the discretion of the user. This field is not used for calculating data.
summarizedDataDate(optional): string(date-time)

The data date of a project.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
websiteUrl(optional): string

Allowed Values: [ "Length[1-200]" ]

The link to a website related to the project.
workspaceId: integer(int64)

The workspace the project is associated with.

{
    "type":"object",
    "required":[
        "projectCode",
        "projectName",
        "workspaceId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValuesProject":{
            "type":"array",
            "description":"The categories of a project.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeValueProject"
            }
        },
        "projectFinancial":{
            "description":"The financial fields associated with a project.",
            "$ref":"#/definitions/ApiEntityProjectFinancial"
        },
        "strgyPriorityNum":{
            "type":"integer",
            "format":"int64",
            "description":"The project's priority in the strategic plan. <br />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."
        },
        "finishDateVariance":{
            "description":"The duration between the project's finish date and default snapshot. <br />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. <br />This value can only be imported.",
            "readOnly":true,
            "$ref":"#/definitions/Duration"
        },
        "remainingDuration":{
            "description":"The duration between the Project Start and Project Finish. <br />This value can be entered manually or can be imported.",
            "readOnly":true,
            "$ref":"#/definitions/Duration"
        },
        "projectAutoNumber":{
            "type":"array",
            "description":"The autonumber settings of a project.",
            "readOnly":true,
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityProjectAutoNumber"
            }
        },
        "forecastStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The planned start date of a project's remaining Forecast cost."
        },
        "forecastFinishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The planned finish date of a project's remaining Forecast cost."
        },
        "startDateVariance":{
            "description":"The duration between the project's start date and default snapshot. <br />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. <br />This value can only be imported.",
            "readOnly":true,
            "$ref":"#/definitions/Duration"
        },
        "actualDuration":{
            "description":"The Actual Duration represents the total working time between the project Actual Start and Actual Finish for a project. <br />This value can be imported. The Actual Duration field is not editable.",
            "readOnly":true,
            "$ref":"#/definitions/Duration"
        },
        "actualLinkType":{
            "type":"string",
            "description":"The field source for the actuals curve in cash flow.",
            "enum":[
                "BUDGET",
                "UDF",
                "MANUAL",
                "ACTUAL",
                "ACT_P6"
            ]
        },
        "percentCompleteWeightedBy":{
            "type":"string",
            "description":"The weight for scope items is calculated using quantity.",
            "readOnly":true,
            "enum":[
                "COST",
                "QUANTITY",
                "HOURS",
                "MANUAL"
            ]
        },
        "isTemplateFlag":{
            "type":"boolean",
            "description":"Indicates the project is a template for creating other projects."
        },
        "spendFinishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The finish date for the project actuals.",
            "readOnly":true
        },
        "lastProjectEvaluationDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the project was last evaluated. "
        },
        "projectIntegrationType":{
            "type":"string",
            "description":"Specifies if the project is integrated with another application.",
            "enum":[
                "P6",
                "UNIFIER"
            ]
        },
        "linkPlannedBudgetTo":{
            "type":"integer",
            "format":"int64",
            "description":"Specifies data to which a project planned budget is linked.",
            "readOnly":true
        },
        "plannedBudgetLinkType":{
            "type":"string",
            "description":"The field source for the planned budget curve in cash flow.",
            "enum":[
                "BUDGET",
                "UDF",
                "MANUAL",
                "ACTUAL",
                "ACT_P6"
            ]
        },
        "isPSyncManaged":{
            "type":"boolean",
            "description":"Indicates the project is synchronized with P6 EPPM.",
            "readOnly":true
        },
        "currentApprovedFinishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The finish date for the Current Approved Budget set by the budget planner.",
            "readOnly":true
        },
        "proposedStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The start date for the Proposed Budget of the project.",
            "readOnly":true
        },
        "linkForecastToSpend":{
            "type":"boolean",
            "description":"Enables you to link project Forecast data to project Actuals data. <br />When linked, any updates to the project's Actuals values will automatically be applied to the project's Forecast values."
        },
        "spendEffectiveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The month in which an actuals value was last added to the project.",
            "readOnly":true
        },
        "currentApprovedStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The start date for the Current Approved Budget set by the budget planner.",
            "readOnly":true
        },
        "linkForecastTo":{
            "type":"integer",
            "format":"int64",
            "description":"Specifies data to which a project forecast is linked."
        },
        "spendStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The start date for the project actuals.",
            "readOnly":true
        },
        "mustFinishByDate":{
            "type":"string",
            "format":"date-time",
            "description":"The latest date on which the scheduled activities must be complete for a project."
        },
        "exchangeRateType":{
            "type":"string",
            "description":"The type of an exchange rate.",
            "enum":[
                "FLOATING",
                "PEGGED"
            ]
        },
        "forecastLinkType":{
            "type":"string",
            "description":"The field source for the forecast curve in cash flow.",
            "enum":[
                "BUDGET",
                "UDF",
                "MANUAL",
                "ACTUAL",
                "ACT_P6"
            ]
        },
        "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.",
            "readOnly":true,
            "enum":[
                "REPORTING_PERIOD",
                "YEARLY",
                "QUARTERLY",
                "MONTHLY",
                "SEMIMONTHLY",
                "WEEKLY",
                "DAILY"
            ]
        },
        "proposedFinishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The finish date for the Proposed Budget of the project.",
            "readOnly":true
        },
        "scheduledFinishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The calculated latest early finish date, which is based on the schedule most recently generated for the project."
        },
        "evaluationScore":{
            "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.",
            "$ref":"#/definitions/Percent"
        },
        "projectCurrency":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a currency."
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The workspace the project is associated with."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which work on the project starts. <br />This value can be entered manually or can be imported."
        },
        "dataDate":{
            "type":"string",
            "format":"date-time",
            "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. <br />The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities."
        },
        "description":{
            "type":"string",
            "description":"The detailed summary for the project. <br />The description provides more information than short names or titles. <br />It can give background information or establish a purpose for the item. <br />These details help differentiate between items with similar names and are especially useful in multi-user environments.",
            "enum":[
                "Length[1-4000]"
            ]
        },
        "status":{
            "type":"string",
            "description":"The current status of a project. <br />Proposal: The project is a project proposal and has not been extensively planned nor accrued any costs. <br />Rejected: The project proposal has been rejected and will not be initiated as a project. <br />Planned: The project is currently planned for execution. Project managers input expected project costs and other project data during this stage. <br />Active: The project is currently active and being executed. <br />Inactive: The project has been rendered inactive and will temporarily accrue no costs. <br />Complete: The project has been successfully completed and will no longer accrue costs.",
            "enum":[
                "PROPOSAL",
                "REJECTED",
                "PLANNED",
                "ACTIVE",
                "INACTIVE",
                "COMPLETE"
            ]
        },
        "actualFinish":{
            "type":"string",
            "format":"date-time",
            "description":"The Actual Finish displays the date on which a project is considered complete. <br />This value can be entered manually or can be imported."
        },
        "actualStart":{
            "type":"string",
            "format":"date-time",
            "description":"The Actual Start indicates the date work on the project began. <br />This value can be entered manually or can be imported."
        },
        "calendarId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the calendar."
        },
        "planStartDate":{
            "type":"string",
            "format":"date-time",
            "description":"The start date for the time phased Planned Budget of the project. <br />Planned Budget cost spread will adjust when this date is changed. <br />The Project Planned Start also represents the earliest date that activities can occur within a project schedule."
        },
        "pegRate":{
            "type":"number",
            "description":"The custom exchange rate for a pegged exchange rate."
        },
        "countryCode":{
            "type":"string",
            "description":"The country for a location."
        },
        "image":{
            "description":"The image associated with a project.",
            "readOnly":true,
            "$ref":"#/definitions/ApiEntityProjectImage"
        },
        "projectCode":{
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "enum":[
                "Length[1-60]"
            ]
        },
        "riskScore":{
            "type":"integer",
            "format":"int32",
            "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."
        },
        "addressLine1":{
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address."
        },
        "stateName":{
            "type":"string",
            "description":"The state, region, or province of a location."
        },
        "securityGuid":{
            "type":"string",
            "description":"Globally unique identifier of a project.",
            "readOnly":true
        },
        "linkActualTo":{
            "type":"integer",
            "format":"int64",
            "description":"Specifies data to which project actuals data is linked."
        },
        "addressLine2":{
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town."
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code, post code, or zip code of a location."
        },
        "riskLevel":{
            "type":"string",
            "description":"The risk level assigned to the project. <br />Projects can have a risk level of very high, high, medium, low, or very low. <br />You can use risk level to determine what projects should be included in your plans, as well as which projects should be of priority.",
            "enum":[
                "VERY_HIGH",
                "HIGH",
                "MEDIUM",
                "LOW",
                "VERY_LOW",
                "NULL"
            ]
        },
        "latitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "locationName":{
            "type":"string",
            "description":"A name for the location that your users will understand and recognize."
        },
        "finishDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which all project work is complete. <br />This value can be entered manually or can be imported."
        },
        "cityName":{
            "type":"string",
            "description":"The city name for a location."
        },
        "websiteUrl":{
            "type":"string",
            "description":"The link to a website related to the project.",
            "enum":[
                "Length[1-200]"
            ]
        },
        "stateCode":{
            "type":"string",
            "description":"A unique identifier for the state or province."
        },
        "longitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "planEndDate":{
            "type":"string",
            "format":"date-time",
            "description":"The finish date for the time phased Planned Budget of the project. <br />Planned Budget cost spread will adjust when this date is changed."
        },
        "recordCount":{
            "type":"integer",
            "format":"int32",
            "description":"The number of comments on a project."
        },
        "sourceId":{
            "type":"string",
            "description":"The unique identifier of a project in an external source."
        },
        "projectName":{
            "type":"string",
            "description":"The name of the project.",
            "enum":[
                "Length[1-255]"
            ]
        },
        "priorityNum":{
            "type":"integer",
            "format":"int64",
            "description":"The project's priority in the strategic plan. <br />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."
        },
        "parentProject":{
            "type":"integer",
            "format":"int64",
            "description":"The workspace the project is associated with.",
            "readOnly":true
        },
        "riskMatrixId":{
            "type":"integer",
            "format":"int64",
            "description":"The risk matrix assigned to the project for calculating project risk scores."
        },
        "planDuration":{
            "description":"The duration between Project Planned Start and Project Planned Finish. <br />This value can be entered manually or can be imported.",
            "readOnly":true,
            "$ref":"#/definitions/Duration"
        },
        "reportCycleId":{
            "type":"integer",
            "format":"int64",
            "description":"The reporting cycle assigned to the project."
        },
        "percentComplete":{
            "description":"The estimated percentage of work that has been completed on the project.",
            "$ref":"#/definitions/Percent"
        },
        "projectSettings":{
            "type":"array",
            "readOnly":true,
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityProjectSetting"
            }
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int32",
            "description":"Determines the order of appearance of projects in a list."
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the project. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "manager":{
            "type":"string",
            "description":"The manager or person responsible for the project."
        },
        "evaluationMatrixId":{
            "type":"integer",
            "format":"int64",
            "description":"The evaluation matrix of a calendar."
        },
        "projectCashFlows":{
            "type":"array",
            "description":"The cash flow of a project.",
            "items":{
                "$ref":"#/definitions/ApiEntityProjectCashFlow"
            }
        },
        "projectConfiguredFields":{
            "description":"The configured fields of a project.",
            "$ref":"#/definitions/ApiEntityProjectConfiguredFields"
        },
        "copyFromProjectId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of the project this data was copied from."
        },
        "summarizedDataDate":{
            "type":"string",
            "format":"date-time",
            "description":"The data date of a project."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityProjectRiskConfiguredFields

Type: object

Show Source

costFlexMap(optional): object costFlexMap

Additional Properties Allowed: additionalProperties

The cost fields of a project risk.
link(optional): string(url)

Read Only: true
otherFlexMap(optional): object otherFlexMap

Additional Properties Allowed: additionalProperties

The other configured fields of a project risk.
primaryKey(optional): integer(int64)
projectRisk(optional): object ApiEntityProjectRisk
projectRiskId(optional): integer(int64)

Project ID.
textFlexMap(optional): object textFlexMap

Additional Properties Allowed: additionalProperties

The text fields associated with a project risk.
uniqueName(optional): string
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "costFlexMap":{
            "type":"object",
            "description":"The cost fields of a project risk.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"The other configured fields of a project risk.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"The text fields associated with a project risk.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "projectRiskId":{
            "type":"integer",
            "format":"int64",
            "description":"Project ID."
        },
        "projectRisk":{
            "description":"Project ID.",
            "$ref":"#/definitions/ApiEntityProjectRisk"
        },
        "primaryKey":{
            "type":"integer",
            "format":"int64"
        },
        "uniqueName":{
            "type":"string"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityProjectRiskFinancial

Type: object

Show Source

actualResponseCost(optional): object Cost
actualResponseCostProject(optional): object Cost
link(optional): string(url)

Read Only: true
plannedResponseCost(optional): object Cost
plannedResponseCostProject(optional): object Cost
postExposureCost(optional): object Cost
postExposureCostProject(optional): object Cost
postQuantifiedCostThreshold(optional): object Cost
postResponseExposureWorkspace1(optional): object Cost
postResponseExposureWorkspace2(optional): object Cost
postResponseExposureWorkspace3(optional): object Cost
preExposureCost(optional): object Cost
preExposureCostProject(optional): object Cost
preQuantifiedCostThreshold(optional): object Cost
preResponseExposureWorkspace1(optional): object Cost
preResponseExposureWorkspace2(optional): object Cost
preResponseExposureWorkspace3(optional): object Cost
projectRiskId(optional): integer(int64)

The unique identifier of a project.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "projectRiskId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project."
        },
        "actualResponseCostProject":{
            "description":"The actual cost of implementing a response action.",
            "$ref":"#/definitions/Cost"
        },
        "plannedResponseCostProject":{
            "description":"The estimated cost of implementing a response action.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseExposureWorkspace1":{
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "preExposureCostProject":{
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "preExposureCost":{
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "postExposureCost":{
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "postExposureCostProject":{
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "preQuantifiedCostThreshold":{
            "description":"The estimated impact size that the risk will have on the project cost before implementing a response action.",
            "$ref":"#/definitions/Cost"
        },
        "postQuantifiedCostThreshold":{
            "description":"The estimated impact size that the risk will have on the project cost after implementing a response action.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseExposureWorkspace2":{
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "actualResponseCost":{
            "description":"The actual cost of implementing the response action.",
            "$ref":"#/definitions/Cost"
        },
        "plannedResponseCost":{
            "description":"The estimated cost associated with implementing the response action.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseExposureWorkspace3":{
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseExposureWorkspace2":{
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseExposureWorkspace3":{
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseExposureWorkspace1":{
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "$ref":"#/definitions/Cost"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityRiskCategory

Type: object

Show Source

link(optional): string(url)

Read Only: true
parentRiskCategory(optional): object ApiEntityRiskCategory
parentRiskCategoryId(optional): integer(int64)

The unique identifier of the parent of a risk type.
riskCategoryId(optional): integer(int64)

The unique identifier of a risk type.
riskCategoryName(optional): string

The category to which the risk belongs.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
workspace(optional): object ApiEntityWorkspace
workspaceId(optional): integer(int64)

The unique identifier of a workspace.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace."
        },
        "workspace":{
            "description":"",
            "$ref":"#/definitions/ApiEntityWorkspace"
        },
        "riskCategoryId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a risk type."
        },
        "parentRiskCategoryId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the parent of a risk type."
        },
        "parentRiskCategory":{
            "description":"",
            "$ref":"#/definitions/ApiEntityRiskCategory"
        },
        "riskCategoryName":{
            "type":"string",
            "description":"The category to which the risk belongs."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityRiskQuantifiedCostImpact

Type: object

Show Source

link(optional): string(url)

Read Only: true
postResponseDistributionShape(optional): string

Allowed Values: [ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]

Determines the distribution that best models the three-point estimates for activity durations after a response.
postResponseMaximum(optional): object Cost
postResponseMaximumProject(optional): object Cost
postResponseMaximumWorkspace1(optional): object Cost
postResponseMaximumWorkspace2(optional): object Cost
postResponseMaximumWorkspace3(optional): object Cost
postResponseMinimum(optional): object Cost
postResponseMinimumProject(optional): object Cost
postResponseMinimumWorkspace1(optional): object Cost
postResponseMinimumWorkspace2(optional): object Cost
postResponseMinimumWorkspace3(optional): object Cost
postResponseMostLikely(optional): object Cost
postResponseMostLikelyProject(optional): object Cost
postResponseMostLikelyWorkspace1(optional): object Cost
postResponseMostLikelyWorkspace2(optional): object Cost
postResponseMostLikelyWorkspace3(optional): object Cost
preResponseDistributionShape(optional): string

Allowed Values: [ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]

Determines the distribution that best models the three-point estimates for activity durations before a response.
preResponseMaximum(optional): object Cost
preResponseMaximumProject(optional): object Cost
preResponseMaximumWorkspace1(optional): object Cost
preResponseMaximumWorkspace2(optional): object Cost
preResponseMaximumWorkspace3(optional): object Cost
preResponseMinimum(optional): object Cost
preResponseMinimumProject(optional): object Cost
preResponseMinimumWorkspace1(optional): object Cost
preResponseMinimumWorkspace2(optional): object Cost
preResponseMinimumWorkspace3(optional): object Cost
preResponseMostLikely(optional): object Cost
preResponseMostLikelyProject(optional): object Cost
preResponseMostLikelyWorkspace1(optional): object Cost
preResponseMostLikelyWorkspace2(optional): object Cost
preResponseMostLikelyWorkspace3(optional): object Cost
projectRiskId(optional): integer(int64)

The unique identifier of a project.
quantifiedCostImpactId(optional): integer(int64)

The unique identifier of a cost impact.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "projectRiskId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project."
        },
        "preResponseMinimumWorkspace3":{
            "description":"The minimum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMostLikely":{
            "description":"The most likely cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMinimumProject":{
            "description":"The minimum cost of responding to a risk event that has occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMinimumWorkspace1":{
            "description":"The minimum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMostLikelyProject":{
            "description":"The most likely cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMaximum":{
            "description":"The maximum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMaximumProject":{
            "description":"The maximum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMaximumWorkspace2":{
            "description":"The maximum cost of responding to a risk event.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMaximumWorkspace1":{
            "description":"The maximum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMinimumWorkspace2":{
            "description":"The minimum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseDistributionShape":{
            "type":"string",
            "description":"Determines the distribution that best models the three-point estimates for activity durations before a response.",
            "enum":[
                "NONE",
                "TRIANGLE",
                "UNIFORM",
                "GAUSSIAN",
                "SINGLE_POINT"
            ]
        },
        "preResponseMinimum":{
            "description":"The minimum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseDistributionShape":{
            "type":"string",
            "description":"Determines the distribution that best models the three-point estimates for activity durations after a response.",
            "enum":[
                "NONE",
                "TRIANGLE",
                "UNIFORM",
                "GAUSSIAN",
                "SINGLE_POINT"
            ]
        },
        "postResponseMinimum":{
            "description":"The minimum cost of responding to a risk event that has occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMostLikely":{
            "description":"The most likely cost of a risk event that has occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMaximumWorkspace2":{
            "description":"The maximum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMaximum":{
            "description":"The maximum cost of responding to a risk event.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMinimumWorkspace1":{
            "description":"The minimum cost of responding to a risk event that has occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMostLikelyProject":{
            "description":"The most likely cost of a risk event that has occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMaximumWorkspace3":{
            "description":"The maximum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMaximumProject":{
            "description":"The maximum cost of responding to a risk event.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMaximumWorkspace1":{
            "description":"The maximum cost of responding to a risk event.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMaximumWorkspace3":{
            "description":"The maximum cost of responding to a risk event.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMinimumProject":{
            "description":"The minimum cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMinimumWorkspace3":{
            "description":"The minimum cost of responding to a risk event that has occurred.",
            "$ref":"#/definitions/Cost"
        },
        "quantifiedCostImpactId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a cost impact."
        },
        "postResponseMinimumWorkspace2":{
            "description":"The minimum cost of responding to a risk event that has occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMostLikelyWorkspace2":{
            "description":"The most likely cost of a risk event that has occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMostLikelyWorkspace1":{
            "description":"The most likely cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMostLikelyWorkspace1":{
            "description":"The most likely cost of a risk event that has occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMostLikelyWorkspace3":{
            "description":"The most likely cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "preResponseMostLikelyWorkspace2":{
            "description":"The most likely cost of preparing for a risk event that has not occurred.",
            "$ref":"#/definitions/Cost"
        },
        "postResponseMostLikelyWorkspace3":{
            "description":"The most likely probability that a risk event will occur.",
            "$ref":"#/definitions/Cost"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : riskQuantifiedOtherImpacts

Type: array

Unique Items Required: true

The impact this risk will have on other data.

Show Source

[0]: object ApiEntityRiskQuantifiedOtherImpact

{
    "type":"array",
    "description":"The impact this risk will have on other data.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityRiskQuantifiedOtherImpact"
    }
}

Nested Schema : ApiEntityCodeValueRisk

Type: object

Show Source

codeType(optional): object ApiEntityCodeType
codeValue(optional): object ApiEntityCodeValue
codeValueRiskId(optional): integer(int64)

The unique identifier of a risk code value.
link(optional): string(url)

Read Only: true
projectRiskId(optional): integer(int64)

The unique identifier of a project.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValue":{
            "description":"The code value identifier for the risk.",
            "$ref":"#/definitions/ApiEntityCodeValue"
        },
        "codeType":{
            "description":"",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "projectRiskId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project."
        },
        "codeValueRiskId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a risk code value."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityCodeType

Type: object

Show Source

assignments(optional): array assignments

Unique Items Required: true

CodeType assignments.
codeTypeCode: string

Allowed Values: [ "Length[1-40]" ]

This field displays the name of a code or value.
codeTypeId(optional): integer(int64)

The system-generated identifier of a code type.
codeTypeName: string

Allowed Values: [ "Length[1-40]" ]

The name of a code or value.
link(optional): string(url)

Read Only: true
pushDownType: string

Allowed Values: [ "MANUAL", "AUTOMATIC" ]

The push down type of the workspace code.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
workspace: integer(int64)

The ID of the owning workspace.

{
    "type":"object",
    "required":[
        "codeTypeCode",
        "codeTypeName",
        "pushDownType",
        "workspace"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a code type."
        },
        "codeTypeName":{
            "type":"string",
            "description":"The name of a code or value.",
            "enum":[
                "Length[1-40]"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace code.",
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "assignments":{
            "type":"array",
            "description":"CodeType assignments.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeEntityType"
            }
        },
        "codeTypeCode":{
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "enum":[
                "Length[1-40]"
            ]
        },
        "workspace":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the owning workspace."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityCodeValue

Type: object

Show Source

codeTypeId: integer(int64)

The ID for the code type.
codeTypeName: string

The name of a code or value.
codeValueCode: string

Allowed Values: [ "LENGTH[1-32]" ]

The unique identifier for the code value.
codeValueId(optional): integer(int64)

The unique identifier for the code value.
codeValueName: string

Allowed Values: [ "LENGTH[1-100]" ]

The name of the code value.
link(optional): string(url)

Read Only: true
parentCodeValue(optional): integer(int64)

The parent code value.
sequenceNumber: integer(int32)

The number that specifies the position of the code value item within the code type list.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "codeTypeId",
        "codeTypeName",
        "codeValueCode",
        "codeValueName",
        "sequenceNumber"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValueId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the code value."
        },
        "codeTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID for the code type."
        },
        "codeValueName":{
            "type":"string",
            "description":"The name of the code value.",
            "enum":[
                "LENGTH[1-100]"
            ]
        },
        "codeValueCode":{
            "type":"string",
            "description":"The unique identifier for the code value.",
            "enum":[
                "LENGTH[1-32]"
            ]
        },
        "codeTypeName":{
            "type":"string",
            "description":"The name of a code or value."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int32",
            "description":"The number that specifies the position of the code value item within the code type list."
        },
        "parentCodeValue":{
            "type":"integer",
            "format":"int64",
            "description":"The parent code value."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : assignments

Type: array

Unique Items Required: true

CodeType assignments.

Show Source

[0]: object ApiEntityCodeEntityType

{
    "type":"array",
    "description":"CodeType assignments.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeEntityType"
    }
}

Nested Schema : ApiEntityCodeEntityType

Type: object

Show Source

codeType: object ApiEntityCodeType
entityType: string

Allowed Values: [ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]

Indicates the type of object the code is associated to.
link(optional): string(url)

Read Only: true
primaryKey: integer(int64)

The unique identifier of a code type table.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "codeType",
        "entityType",
        "primaryKey"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeType":{
            "description":"The unique identifier of a code type.",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "entityType":{
            "type":"string",
            "description":"Indicates the type of object the code is associated to.",
            "enum":[
                "SCOPE_ITEM",
                "PROJECT",
                "SCOPE_ASSIGNMENT",
                "WBS",
                "WORK_PACKAGE",
                "ACTIVITY",
                "RESOURCE",
                "PBS",
                "CONTRACT",
                "RISK",
                "COMMITMENT",
                "REPORT",
                "TASKS",
                "STRATEGY",
                "PORTFOLIO",
                "FUND",
                "SUBMITTAL",
                "CHANGE_ORDER",
                "PAYMENT_APPLICATION",
                "CHANGE_EVENT",
                "CHANGES_ESTIMATES",
                "IDEA",
                "RFI",
                "CUSTOM_LOG_ITEM"
            ]
        },
        "primaryKey":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a code type table."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityRiskImpact

Type: object

Show Source

link(optional): string(url)

Read Only: true
postRiskScoreThresholdCode(optional): string
postRiskScoreThresholdId(optional): integer(int64)

The unique identifier for the post response impact threshold.
projectName(optional): string
projectRisk(optional): object ApiEntityProjectRisk
projectRiskId(optional): integer(int64)

The unique identifier of the project to which the risk is assigned.
riskCode(optional): string
riskImpactId(optional): integer(int64)

A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the scoretype.
riskScoreThreshold(optional): object ApiEntityRiskScoreThreshold
riskScoreThresholdCode(optional): string
riskScoreThresholdId(optional): integer(int64)

The threshold of the risk score.
riskScoreType(optional): object ApiEntityRiskScoreType
riskScoreTypeId(optional): integer(int64)

The risk score type.
riskScoreTypeName(optional): string
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "projectRiskId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the project to which the risk is assigned."
        },
        "projectName":{
            "type":"string",
            "description":""
        },
        "projectRisk":{
            "description":"",
            "$ref":"#/definitions/ApiEntityProjectRisk"
        },
        "riskCode":{
            "type":"string",
            "description":""
        },
        "riskImpactId":{
            "type":"integer",
            "format":"int64",
            "description":"A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the scoretype."
        },
        "riskScoreType":{
            "description":"",
            "$ref":"#/definitions/ApiEntityRiskScoreType"
        },
        "postRiskScoreThresholdId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the post response impact threshold."
        },
        "riskScoreTypeName":{
            "type":"string",
            "description":""
        },
        "riskScoreThresholdId":{
            "type":"integer",
            "format":"int64",
            "description":"The threshold of the risk score."
        },
        "riskScoreThreshold":{
            "description":"",
            "$ref":"#/definitions/ApiEntityRiskScoreThreshold"
        },
        "riskScoreThresholdCode":{
            "type":"string",
            "description":""
        },
        "postRiskScoreThresholdCode":{
            "type":"string",
            "description":""
        },
        "riskScoreTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The risk score type."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityRiskScoreThreshold

Type: object

Show Source

color(optional): string

The color that represents the urgency of the risk.
level(optional): integer(int32)

The level of the risk threshold.
link(optional): string(url)

Read Only: true
lower(optional): number(double)

The lower limit of the risk score threshold range.
riskScoreThresholdCode(optional): string

The unique identifier for the risk scoring threshold.
riskScoreThresholdId(optional): integer(int64)

The unique ID of the risk score threshold.
riskScoreThresholdName(optional): string

The name of the risk threshold.
riskScoreType(optional): object ApiEntityRiskScoreType
riskScoreTypeId(optional): integer(int64)

The category to which the risk score belongs.
riskScoreTypeName(optional): string

The name of the risk score type.
stringValue(optional): string

The value of the string.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
upper(optional): number(double)

The upper limit of the risk score threshold range.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "lower":{
            "type":"number",
            "format":"double",
            "description":"The lower limit of the risk score threshold range."
        },
        "upper":{
            "type":"number",
            "format":"double",
            "description":"The upper limit of the risk score threshold range."
        },
        "level":{
            "type":"integer",
            "format":"int32",
            "description":"The level of the risk threshold."
        },
        "color":{
            "type":"string",
            "description":"The color that represents the urgency of the risk."
        },
        "stringValue":{
            "type":"string",
            "description":"The value of the string."
        },
        "riskScoreType":{
            "description":"Risk Score Type.",
            "$ref":"#/definitions/ApiEntityRiskScoreType"
        },
        "riskScoreTypeName":{
            "type":"string",
            "description":"The name of the risk score type."
        },
        "riskScoreThresholdId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique ID of the risk score threshold."
        },
        "riskScoreThresholdCode":{
            "type":"string",
            "description":"The unique identifier for the risk scoring threshold."
        },
        "riskScoreTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The category to which the risk score belongs."
        },
        "riskScoreThresholdName":{
            "type":"string",
            "description":"The name of the risk threshold."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityRiskScoreType

Type: object

Show Source

link(optional): string(url)

Read Only: true
projectId(optional): integer(int64)

The unique identifier of a project.
pushDownType(optional): string

Allowed Values: [ "MANUAL", "AUTOMATIC" ]

The push down type of the risk score.
referencedScoreTypeId(optional): integer(int64)

The unique identifier of a copied score type.
riskScoreThresholds(optional): array riskScoreThresholds

Unique Items Required: true

Risk score thresholds.
riskScoreTypeId(optional): integer(int64)

The unique identifier of a score type.
riskScoreTypeName(optional): string

The name of the risk score type.
scoreType(optional): string

Allowed Values: [ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]

The type of risk score.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
workspace(optional): object ApiEntityWorkspace
workspaceId(optional): integer(int64)

The unique identifier of a workspace.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace."
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the risk score.",
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "workspace":{
            "description":"A workspace object.",
            "$ref":"#/definitions/ApiEntityWorkspace"
        },
        "scoreType":{
            "type":"string",
            "description":"The type of risk score.",
            "enum":[
                "PROBABILITY",
                "SCHEDULE",
                "RELATIVE_SCHEDULE",
                "COST",
                "RELATIVE_COST",
                "USER"
            ]
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project."
        },
        "riskScoreTypeName":{
            "type":"string",
            "description":"The name of the risk score type."
        },
        "riskScoreTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a score type."
        },
        "riskScoreThresholds":{
            "type":"array",
            "description":"Risk score thresholds.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityRiskScoreThreshold"
            }
        },
        "referencedScoreTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a copied score type."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : riskScoreThresholds

Type: array

Unique Items Required: true

Risk score thresholds.

Show Source

[0]: object ApiEntityRiskScoreThreshold

{
    "type":"array",
    "description":"Risk score thresholds.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityRiskScoreThreshold"
    }
}

Nested Schema : ApiEntityWorkspace

Type: object

Show Source

description(optional): string

Summary of the workspace.
image(optional): object ApiEntityWorkspaceImage
isProduction(optional): boolean

Read Only: true

Indicates a workspace that is in production.
All workspaces created under the Production workspace are automatically designated as production.
This cannot be changed.
isSysGenerated(optional): boolean

Read Only: true

Indicates a workspace that was created by the system.
System generated workspaces cannot be deleted.
link(optional): string(url)

Read Only: true
parentWorkspace(optional): integer(int64)

The unique identifier of the workspace hierarchically above another workspace.
securityGuid(optional): string

The Globally Unique Identifier of the workspace.
sequenceNumber(optional): integer(int32)

Determines the order of appearance of workspaces in a list.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
workspaceAutonumSettings(optional): array workspaceAutonumSettings

Unique Items Required: true

An object containing workspace autonumber settings.
workspaceCode(optional): string

Workspace Code.
workspaceId(optional): integer(int64)

The unique identifier of a workspace.
workspaceName(optional): string

Name of a workspace.
workspaceSettings(optional): array workspaceSettings

Unique Items Required: true

An object containing workspace settings.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace."
        },
        "description":{
            "type":"string",
            "description":"Summary of the workspace."
        },
        "workspaceName":{
            "type":"string",
            "description":"Name of a workspace."
        },
        "isProduction":{
            "type":"boolean",
            "description":"Indicates a workspace that is in production.  <br />All workspaces created under the Production workspace are automatically designated as production. <br />This cannot be changed.",
            "readOnly":true
        },
        "workspaceCode":{
            "type":"string",
            "description":"Workspace Code."
        },
        "image":{
            "description":"An image associated with the workspace.",
            "$ref":"#/definitions/ApiEntityWorkspaceImage"
        },
        "securityGuid":{
            "type":"string",
            "description":"The Globally Unique Identifier of the workspace."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int32",
            "description":"Determines the order of appearance of workspaces in a list."
        },
        "workspaceSettings":{
            "type":"array",
            "description":"An object containing workspace settings.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityWorkspaceSetting"
            }
        },
        "workspaceAutonumSettings":{
            "type":"array",
            "description":"An object containing workspace autonumber settings.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityWorkspaceAutonumSetting"
            }
        },
        "parentWorkspace":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the workspace hierarchically above another workspace."
        },
        "isSysGenerated":{
            "type":"boolean",
            "description":"Indicates a workspace that was created by the system. <br />System generated workspaces cannot be deleted.",
            "readOnly":true
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityWorkspaceImage

Type: object

Show Source

image(optional): array image

An image object represented in binary format.
imageType: string

Allowed Values: [ "PNG", "JPEG", "GIF" ]

The file type of the image. Valid values are PNG, JPEG, and GIF.
link(optional): string(url)

Read Only: true
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
workspaceId: integer(int64)

The unique identifier of the workspace that contains this image.
workspaceImageId: integer(int64)

The unique identifier of the image.

{
    "type":"object",
    "required":[
        "imageType",
        "workspaceId",
        "workspaceImageId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the workspace that contains this image."
        },
        "image":{
            "type":"array",
            "description":"An image object represented in binary format.",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "imageType":{
            "type":"string",
            "description":"The file type of the image. Valid values are <b>PNG</b>, <b>JPEG</b>, and  <b>GIF</b>.",
            "enum":[
                "PNG",
                "JPEG",
                "GIF"
            ]
        },
        "workspaceImageId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the image."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : workspaceAutonumSettings

Type: array

Unique Items Required: true

An object containing workspace autonumber settings.

Show Source

[0]: object ApiEntityWorkspaceAutonumSetting

{
    "type":"array",
    "description":"An object containing workspace autonumber settings.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityWorkspaceAutonumSetting"
    }
}

Nested Schema : workspaceSettings

Type: array

Unique Items Required: true

An object containing workspace settings.

Show Source

[0]: object ApiEntityWorkspaceSetting

{
    "type":"array",
    "description":"An object containing workspace settings.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityWorkspaceSetting"
    }
}

Nested Schema : image

Type: array

An image object represented in binary format.

Show Source

[0]: string(byte)

{
    "type":"array",
    "description":"An image object represented in binary format.",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

Nested Schema : ApiEntityWorkspaceAutonumSetting

Type: object

Show Source

area(optional): string

Allowed Values: [ "IDEA", "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "ACTUALS", "WORK_MANAGER_TASK", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM" ]

Identifies the type of object used for auto numbering.
autonumId(optional): integer(int64)

The unique identifier of an auto numbering sequence.
link(optional): string(url)

Read Only: true
name(optional): string

Name of the auto numbering sequence.
prefix(optional): string

Initial characters for the workspace auto numbering sequence.
suffix(optional): string

The first number in the workspace auto numbering sequence.
suffixIncrement(optional): integer(int32)

Number by which the auto numbering suffix is incremented.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
workspaceId(optional): integer(int64)

The unique identifier of a workspace.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the auto numbering sequence."
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace."
        },
        "prefix":{
            "type":"string",
            "description":"Initial characters for the workspace auto numbering sequence."
        },
        "suffix":{
            "type":"string",
            "description":"The first number in the workspace auto numbering sequence."
        },
        "area":{
            "type":"string",
            "description":"Identifies the type of object used for auto numbering.",
            "enum":[
                "IDEA",
                "ACTIVITY",
                "ACTIVITY_ASSIGNMENT",
                "SCOPE_ITEM",
                "SCOPE_ASSIGNMENT",
                "CHANGE_ITEM",
                "WORK_PACKAGE",
                "CHANGE_REQUEST",
                "CONTRACT",
                "COMMITMENT",
                "BUDGET_CHANGE",
                "BUDGET_TRANSFER",
                "CHANGE_ORDER",
                "POTENTIAL_CHANGE_ORDER",
                "PAYMENT_APPLICATION",
                "RISK",
                "ACTUALS",
                "WORK_MANAGER_TASK",
                "SUBMITTAL",
                "CHANGE_EVENT",
                "RFI",
                "CUSTOM_LOGS_ITEM"
            ]
        },
        "autonumId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of an auto numbering sequence."
        },
        "suffixIncrement":{
            "type":"integer",
            "format":"int32",
            "description":"Number by which the auto numbering suffix is incremented."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityWorkspaceSetting

Type: object

Show Source

link(optional): string(url)

Read Only: true
settingName: string

Name of a workspace setting.
settingValue: string

Value of a workspace setting.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
workspaceId: integer(int64)

The unique identifier of a workspace setting.
workspaceSettingId: integer(int64)

The unique identifier of a workspace setting.

{
    "type":"object",
    "required":[
        "settingName",
        "settingValue",
        "workspaceId",
        "workspaceSettingId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace setting."
        },
        "settingValue":{
            "type":"string",
            "description":"Value of a workspace setting."
        },
        "settingName":{
            "type":"string",
            "description":"Name of a workspace setting."
        },
        "workspaceSettingId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace setting."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : Duration

Type: object

Show Source

bigDecimal(optional): number
double(optional): number(double)

{
    "type":"object",
    "properties":{
        "double":{
            "type":"number",
            "format":"double"
        },
        "bigDecimal":{
            "type":"number"
        }
    }
}

Nested Schema : codeValuesProject

Type: array

Unique Items Required: true

The categories of a project.

Show Source

[0]: object ApiEntityCodeValueProject

{
    "type":"array",
    "description":"The categories of a project.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeValueProject"
    }
}

Nested Schema : Percent

Type: object

Show Source

bigDecimal(optional): number
double(optional): number(double)

{
    "type":"object",
    "properties":{
        "double":{
            "type":"number",
            "format":"double"
        },
        "bigDecimal":{
            "type":"number"
        }
    }
}

Nested Schema : ApiEntityProjectImage

Type: object

Show Source

image: array image

The image file uploaded to the project.
Displayed throughout the application in areas like news feeds.
imageType: string

Allowed Values: [ "PNG", "JPEG", "GIF" ]

The mime type of an image associated with a project.
link(optional): string(url)

Read Only: true
project(optional): integer(int64)

The system-generated identifier of a project.
projectImageId(optional): integer(int64)

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.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "image",
        "imageType"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "project":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a project."
        },
        "image":{
            "type":"array",
            "description":"The image file uploaded to the project. <br />Displayed throughout the application in areas like news feeds.",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "imageType":{
            "type":"string",
            "description":"The mime type of an image associated with a project.",
            "enum":[
                "PNG",
                "JPEG",
                "GIF"
            ]
        },
        "projectImageId":{
            "type":"integer",
            "format":"int64",
            "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."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : projectAutoNumber

Type: array

Read Only: true

Unique Items Required: true

The autonumber settings of a project.

Show Source

[0]: object ApiEntityProjectAutoNumber

{
    "type":"array",
    "description":"The autonumber settings of a project.",
    "readOnly":true,
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityProjectAutoNumber"
    }
}

Nested Schema : projectCashFlows

Type: array

The cash flow of a project.

Show Source

[0]: object ApiEntityProjectCashFlow

{
    "type":"array",
    "description":"The cash flow of a project.",
    "items":{
        "$ref":"#/definitions/ApiEntityProjectCashFlow"
    }
}

Nested Schema : ApiEntityProjectConfiguredFields

Type: object

Show Source

costFlexMap(optional): object costFlexMap

Additional Properties Allowed: additionalProperties

The cost fields associated with a project.
link(optional): string(url)

Read Only: true
otherFlexMap(optional): object otherFlexMap

Additional Properties Allowed: additionalProperties

The non-cost and non-text fields associated with a project.
project(optional): object ApiEntityProject
projectId(optional): integer(int64)

The unique identifier for the project.
textFlexMap(optional): object textFlexMap

Additional Properties Allowed: additionalProperties

The text fields associated with a project.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "project":{
            "description":"A project object.",
            "$ref":"#/definitions/ApiEntityProject"
        },
        "costFlexMap":{
            "type":"object",
            "description":"The cost fields associated with a project.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"The non-cost and non-text fields associated with a project.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"The text fields associated with a project.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the project."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityProjectFinancial

Type: object

Show Source

actualCost(optional): object Cost
allocatedFundApprovedBudgetVariance(optional): object Cost
allocatedFundForecastVariance(optional): object Cost
allocatedFundPlannedBudgetVariance(optional): object Cost
annualDiscountRate(optional): object Percent
atCompletionCost(optional): object Cost
constructionValue(optional): object Cost
costPerfIndex(optional): number(double)

The measure of a project's cost efficiency.
A value of less than 1 indicates the project is over budget, while a value greater than 1 indicates the project is under budget.
This value can be entered manually or can be imported.
costVariance(optional): object Cost
currentApprovedBudget(optional): object Cost
currentApprovedBudgetBaseDistributed(optional): object Cost
currentApprovedBudgetBaseUndistributed(optional): object Cost
currentApprovedSpendVariance(optional): object Cost
earnedValueCost(optional): object Cost
estAtCompleteCost(optional): object Cost
estToCompleteCost(optional): object Cost
forecastCost(optional): object Cost
forecastCostDistributed(optional): object Cost
forecastCostUndistributed(optional): object Cost
forecastCurrApprVar(optional): object Cost
intRateReturn(optional): object Percent
link(optional): string(url)

Read Only: true
netPresentValue(optional): object Cost
paybackPeriod(optional): number(double)

The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected project.

This value can be entered manually or can be imported.
plannedBudget(optional): object Cost
plannedBudgetDistributed(optional): object Cost
plannedBudgetUndistributed(optional): object Cost
plannedValueCost(optional): object Cost
profitabilityIndex(optional): number(double)

The index based on the value of a project's present values divided by initial project investments.
project: object ApiEntityProject
projectId(optional): integer(int64)

The unique identifier for a project set by the user who created the project.
proposedBudget(optional): object Cost
proposedBudgetBaseDistributed(optional): object Cost
proposedBudgetBaseUndistributed(optional): object Cost
proposedForecastVariance(optional): object Cost
proposedPlannedVar(optional): object Cost
remainingCost(optional): object Cost
returnInvestment(optional): object Percent
schedPerfIndex(optional): number(double)

The measure of the work accomplished as a percentage of the work scheduled on a project.
Schedule Performance Index indicates whether you are meeting earned and planned values within your project schedule.
A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the project is ahead of schedule.
This value can be entered manually or can be imported.
scheduleVariance(optional): object Cost
spendCost(optional): object Cost
spendForecastVar(optional): object Cost
spendPlannedVariance(optional): object Cost
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
yearEndForecastCost(optional): object Cost
ytdSpendCost(optional): object Cost

{
    "type":"object",
    "required":[
        "project"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "project":{
            "description":"Project object of project financial.",
            "$ref":"#/definitions/ApiEntityProject"
        },
        "costVariance":{
            "description":"The measure of cost performance on a project. <br />A negative value indicates that the Actual Cost has exceeded the planned value. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Cost"
        },
        "forecastCost":{
            "description":"The total estimation of a project's remaining costs. <br />Once projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle.",
            "$ref":"#/definitions/Cost"
        },
        "ytdSpendCost":{
            "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "plannedBudget":{
            "description":"The planned total cost of a project as defined by the project manager. <br />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.",
            "$ref":"#/definitions/Cost"
        },
        "actualCost":{
            "description":"Total costs accrued on a project within a given time period. <br />The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule. <br />Actual Cost data is only available when the application is connected with P6 EPPM and is not editable.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "paybackPeriod":{
            "type":"number",
            "format":"double",
            "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. <br /><br /><br />This value can be entered manually or can be imported."
        },
        "costPerfIndex":{
            "type":"number",
            "format":"double",
            "description":"The measure of a project's cost efficiency. <br />A value of less than 1 indicates the project is over budget, while a value greater than 1 indicates the project is under budget. <br />This value can be entered manually or can be imported."
        },
        "remainingCost":{
            "description":"The remaining total cost for the project, including labor resources, nonlabor resources, and project expenses. <br />This value can be imported.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "intRateReturn":{
            "description":"The quantitative measurement used to compare the profitability of project investments. <br />The rate at which investors will receive returns on their investments in a project. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Percent"
        },
        "spendCost":{
            "description":"The total amount incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a project has a status of Proposal.",
            "$ref":"#/definitions/Cost"
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for a project set by the user who created the project."
        },
        "proposedBudgetBaseUndistributed":{
            "description":"The amount of proposed budget unallocated across the project timescale.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "currentApprovedBudgetBaseDistributed":{
            "description":"The amount of approved budget currently allocated across the project timescale.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "allocatedFundApprovedBudgetVariance":{
            "description":"The total and time phased variance between the project's Allocated Fund and Approved Budget.",
            "$ref":"#/definitions/Cost"
        },
        "currentApprovedBudgetBaseUndistributed":{
            "description":"The amount of approved budget unallocated across the project timescale.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "allocatedFundPlannedBudgetVariance":{
            "description":"The total and time phased variance between the project's Allocated Fund and Planned Budget.",
            "$ref":"#/definitions/Cost"
        },
        "scheduleVariance":{
            "description":"The measure of schedule performance on a project. <br />A negative value indicates that less work was actually performed than was scheduled. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Cost"
        },
        "earnedValueCost":{
            "description":"The value of work performed on a project in reference to the approved budget for the project. <br />The cost value used for the Earned Value Management of a project. <br />Earned Value Management allows project managers to quantify project progress and objectively measure a project's success. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Cost"
        },
        "plannedValueCost":{
            "description":"The amount of approved capital spent on a scheduled portion of work on a project. <br />Planned Value Cost is often used for Earned Value Management. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Cost"
        },
        "proposedBudget":{
            "description":"The Proposed Budget for the project as allocated by the budget planner. <br />Project managers can measure the proposed budget for their projects against their own planned budgets and project forecasts. <br />If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews. <br />Proposed Budget becomes the project's Approved Budget after the portfolio budget plan scenario is approved.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "netPresentValue":{
            "description":"The difference between the present value (PV) of the future cash flows from current investments and project costs. <br />The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital. <br />Positive Net Present Value (NPV) is an indicator of projects that should be pursued. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Cost"
        },
        "returnInvestment":{
            "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a project or portfolio. <br />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%. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Percent"
        },
        "annualDiscountRate":{
            "description":"The interest rate associated with the cost of an investment from your commercial bank or another funding source. <br />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. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Percent"
        },
        "profitabilityIndex":{
            "type":"number",
            "format":"double",
            "description":"The index based on the value of a project's present values divided by initial project investments."
        },
        "proposedBudgetBaseDistributed":{
            "description":"The amount of proposed budget currently allocated across the project timescale.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "plannedBudgetDistributed":{
            "description":"The amount of planned budget allocated across the project timescale.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "forecastCostDistributed":{
            "description":"The amount of forecast cost currently allocated across the project timescale.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "schedPerfIndex":{
            "type":"number",
            "format":"double",
            "description":"The measure of the work accomplished as a percentage of the work scheduled on a project. <br />Schedule Performance Index indicates whether you are meeting earned and planned values within your project schedule. <br />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. <br />This value can be entered manually or can be imported."
        },
        "atCompletionCost":{
            "description":"The At Completion Total Cost from a cost-loaded P6 EPPM schedule. <br />At Completion data is only available when the application is connected to P6 EPPM and is not editable. <br />The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "estAtCompleteCost":{
            "description":"The expected total cost of the project when the defined scope of work will be completed. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Cost"
        },
        "plannedBudgetUndistributed":{
            "description":"The amount of planned budget unallocated across the project timescale.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "spendForecastVar":{
            "description":"The total and time phased variance between the project's Actuals and Forecast.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "forecastCostUndistributed":{
            "description":"The amount of forecast cost unallocated across the project timescale.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "currentApprovedSpendVariance":{
            "description":"The total and time phased variance between the project's Approved Budget and Actuals.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "forecastCurrApprVar":{
            "description":"The total and time phased variance between the project's Forecast and Approved Budget.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "estToCompleteCost":{
            "description":"The estimated cost needed to complete the project. <br />This value can be entered manually or can be imported.",
            "$ref":"#/definitions/Cost"
        },
        "proposedForecastVariance":{
            "description":"The total and time phased variance between the project's Proposed Budget and Forecast.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "proposedPlannedVar":{
            "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "spendPlannedVariance":{
            "description":"The total and time phased variance between the project's Actuals and Planned Budget.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "yearEndForecastCost":{
            "description":"Total forecast at the end of year actuals till date, with respect to the current year.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "constructionValue":{
            "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.",
            "$ref":"#/definitions/Cost"
        },
        "allocatedFundForecastVariance":{
            "description":"The total and time phased variance between the project's Allocated Fund and Forecast.",
            "$ref":"#/definitions/Cost"
        },
        "currentApprovedBudget":{
            "description":"The budget currently approved for the project. <br />Current Approved Budget values are derived from the Proposed Budget set by the budget planner. <br />A Proposed Budget becomes the Approved Budget after the budget scenario has undergone the approval process.",
            "readOnly":true,
            "$ref":"#/definitions/Cost"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : projectSettings

Type: array

Read Only: true

Unique Items Required: true

Show Source

[0]: object ApiEntityProjectSetting

{
    "type":"array",
    "readOnly":true,
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityProjectSetting"
    }
}

Nested Schema : ApiEntityCodeValueProject

Type: object

Show Source

codeType(optional): object ApiEntityCodeType
codeValue: object ApiEntityCodeValue
codeValueProjectId: integer(int64)

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.
link(optional): string(url)

Read Only: true
projectId(optional): integer(int64)

The unique identifier for the project.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "codeValue",
        "codeValueProjectId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValue":{
            "description":"The Code Value identifier for the project.",
            "$ref":"#/definitions/ApiEntityCodeValue"
        },
        "codeType":{
            "description":"The type of a code.",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the project."
        },
        "codeValueProjectId":{
            "type":"integer",
            "format":"int64",
            "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."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : image

Type: array

The image file uploaded to the project.
Displayed throughout the application in areas like news feeds.

Show Source

[0]: string(byte)

{
    "type":"array",
    "description":"The image file uploaded to the project. <br />Displayed throughout the application in areas like news feeds.",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

Nested Schema : ApiEntityProjectAutoNumber

Type: object

Show Source

area(optional): string

Allowed Values: [ "IDEA", "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "ACTUALS", "WORK_MANAGER_TASK", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM" ]

Identifies the type of object used for auto numbering.
increment: integer(int32)

The number to increment the starting number by.
link(optional): string(url)

Read Only: true
name: string

This is an internal field.
prefix: string

Allowed Values: [ "Length[1-20]" ]

The initial characters for the auto numbering sequence.
projectAutoNumberId(optional): integer(int64)

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.
suffix: string

The first number in the auto numbering sequence.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "increment",
        "name",
        "prefix",
        "suffix"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"This is an internal field."
        },
        "prefix":{
            "type":"string",
            "description":"The initial characters for the auto numbering sequence.",
            "enum":[
                "Length[1-20]"
            ]
        },
        "suffix":{
            "type":"string",
            "description":"The first number in the auto numbering sequence."
        },
        "area":{
            "type":"string",
            "description":"Identifies the type of object used for auto numbering.",
            "enum":[
                "IDEA",
                "ACTIVITY",
                "ACTIVITY_ASSIGNMENT",
                "SCOPE_ITEM",
                "SCOPE_ASSIGNMENT",
                "CHANGE_ITEM",
                "WORK_PACKAGE",
                "CHANGE_REQUEST",
                "CONTRACT",
                "COMMITMENT",
                "BUDGET_CHANGE",
                "BUDGET_TRANSFER",
                "CHANGE_ORDER",
                "POTENTIAL_CHANGE_ORDER",
                "PAYMENT_APPLICATION",
                "RISK",
                "ACTUALS",
                "WORK_MANAGER_TASK",
                "SUBMITTAL",
                "CHANGE_EVENT",
                "RFI",
                "CUSTOM_LOGS_ITEM"
            ]
        },
        "increment":{
            "type":"integer",
            "format":"int32",
            "description":"The number to increment the starting number by."
        },
        "projectAutoNumberId":{
            "type":"integer",
            "format":"int64",
            "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."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityProjectCashFlow

Type: object

Show Source

actualCost: object Cost
actualForecastVar(optional): object Cost
atCompletionCost(optional): object Cost
currentApprovedBudget(optional): object Cost
currentApprovedSpendVariance(optional): object Cost
forecastCost: object Cost
forecastCurrApprVar(optional): object Cost
link(optional): string(url)

Read Only: true
month: integer(int32)

The time period during which budget planning for the project takes place in months.
plannedBudget: object Cost
projectId: integer(int64)

The unique identifier for the project.
projectPhaseFinancialId(optional): integer(int64)

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.
proposedBudget(optional): object Cost
proposedForecastVariance(optional): object Cost
proposedPlannedVar(optional): object Cost
spendCost(optional): object Cost
spendForecastVar(optional): object Cost
spendPlannedVariance(optional): object Cost
spreadDate(optional): string(date-time)

The starting date for a time phase of the project life cycle.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
year: integer(int32)

The time period during which budget planning for the project takes place in years.
yearEndBudger(optional): object Cost
yearEndForecastCost(optional): object Cost
ytdActualCost(optional): object Cost
ytdSpendCost(optional): object Cost

{
    "type":"object",
    "required":[
        "actualCost",
        "forecastCost",
        "month",
        "plannedBudget",
        "projectId",
        "year"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "month":{
            "type":"integer",
            "format":"int32",
            "description":"The time period during which budget planning for the project takes place in months."
        },
        "year":{
            "type":"integer",
            "format":"int32",
            "description":"The time period during which budget planning for the project takes place in years."
        },
        "spreadDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date for a time phase of the project life cycle."
        },
        "yearEndBudger":{
            "description":"Project Phase Financial yearEndBudger",
            "$ref":"#/definitions/Cost"
        },
        "ytdActualCost":{
            "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year.",
            "$ref":"#/definitions/Cost"
        },
        "forecastCost":{
            "description":"The time phased estimation of a project's remaining costs. <br />After projects have begun, project managers update the project forecast to represent remaining cost estimates for the duration of the project's life cycle. <br />Project managers can use time phasing to portray a detailed prediction of when the project will accrue its highest actuals.",
            "$ref":"#/definitions/Cost"
        },
        "ytdSpendCost":{
            "description":"A measurement of capital spent on a project starting from the beginning of the year up to the present date. <br />YTD Actuals provides an overview of the total amount of actuals accrued on a project over the current Period Year.",
            "$ref":"#/definitions/Cost"
        },
        "plannedBudget":{
            "description":"The planned time phased cost of a project as defined by the project manager. <br />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. <br />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.",
            "$ref":"#/definitions/Cost"
        },
        "actualCost":{
            "description":"Total costs accrued on a project within a given time period. <br />The Actual Cost data for the project's life cycle is pulled from the P6 EPPM schedule. <br />Actual Cost data is only available when the application is connected with P6 EPPM and is not editable.",
            "$ref":"#/definitions/Cost"
        },
        "spendCost":{
            "description":"The time phased actual spends incurred on a project throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a project has a status of Proposal.",
            "$ref":"#/definitions/Cost"
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the project."
        },
        "proposedBudget":{
            "description":"The time phased Proposed Budget for the project as allocated by the budget planner. <br />Project managers can measure the proposed budget for their projects against their own Planned Budgets and project Forecasts. <br />If necessary, managers can request the planner make changes to the proposed budget allocated to their projects during budget plan scenario reviews. <br />Becomes the projects Current Approved Budget after the portfolio budget plan scenario is approved.",
            "$ref":"#/definitions/Cost"
        },
        "atCompletionCost":{
            "description":"Calculated as the sum of the Actual Costs plus Remaining Costs for the project. <br />You can copy the values of At Completion into the project's Forecast to accurately track the time phased costs of the project. <br />At Completion data is only available when the application is connected to P6 EPPM and is not editable. <br />The At Completion field is populated with the At Completion Total Cost from the project's P6 EPPM schedule.",
            "$ref":"#/definitions/Cost"
        },
        "spendForecastVar":{
            "description":"The total and time phased variance between the project's Actuals and Forecast.",
            "$ref":"#/definitions/Cost"
        },
        "currentApprovedSpendVariance":{
            "description":"The total and time phased variance between the project's Approved Budget and Actuals.",
            "$ref":"#/definitions/Cost"
        },
        "forecastCurrApprVar":{
            "description":"The total and time phased variance between the project's Forecast and Current Approved Budget.",
            "$ref":"#/definitions/Cost"
        },
        "proposedForecastVariance":{
            "description":"The total and time phased variance between the project's Proposed Budget and Forecast.",
            "$ref":"#/definitions/Cost"
        },
        "proposedPlannedVar":{
            "description":"The total and time phased variance between the project's Proposed Budget and Planned Budget.",
            "$ref":"#/definitions/Cost"
        },
        "spendPlannedVariance":{
            "description":"The total and time phased variance between the project's Actuals and Planned Budget.",
            "$ref":"#/definitions/Cost"
        },
        "yearEndForecastCost":{
            "description":"Total forecast at the end of year actuals till date, with respect to the current year.",
            "$ref":"#/definitions/Cost"
        },
        "currentApprovedBudget":{
            "description":"The approved time phased budget currently allocated to the project. <br />Current Approved Budget values are derived from the Proposed Budget set by the capital planner. <br />A Proposed Budget becomes a Current Approved Budget after the capital plan scenario has undergone the approval process.",
            "$ref":"#/definitions/Cost"
        },
        "actualForecastVar":{
            "description":"The total and time phased variance between the project's Actuals and Forecast.",
            "$ref":"#/definitions/Cost"
        },
        "projectPhaseFinancialId":{
            "type":"integer",
            "format":"int64",
            "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."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : Cost

Type: object

Nested Schema : costFlexMap

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"The cost fields associated with a project.",
    "additionalProperties":{
        "type":"object"
    }
}

The cost fields associated with a project.

Nested Schema : otherFlexMap

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"The non-cost and non-text fields associated with a project.",
    "additionalProperties":{
        "type":"object"
    }
}

The non-cost and non-text fields associated with a project.

Nested Schema : textFlexMap

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"The text fields associated with a project.",
    "additionalProperties":{
        "type":"object"
    }
}

The text fields associated with a project.

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

Nested Schema : ApiEntityProjectSetting

Type: object

Show Source

link(optional): string(url)

Read Only: true
projectId(optional): integer(int64)

The unique identifier of a project.
projectSettingId(optional): integer(int64)

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.
settingName(optional): string

The name of a project button.
settingValue(optional): string

Value of a project setting.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project."
        },
        "settingValue":{
            "type":"string",
            "description":"Value of a project setting."
        },
        "settingName":{
            "type":"string",
            "description":"The name of a project button."
        },
        "projectSettingId":{
            "type":"integer",
            "format":"int64",
            "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."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Nested Schema : costFlexMap

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"The cost fields of a project risk.",
    "additionalProperties":{
        "type":"object"
    }
}

The cost fields of a project risk.

Nested Schema : otherFlexMap

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"The other configured fields of a project risk.",
    "additionalProperties":{
        "type":"object"
    }
}

The other configured fields of a project risk.

Nested Schema : textFlexMap

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"The text fields associated with a project risk.",
    "additionalProperties":{
        "type":"object"
    }
}

The text fields associated with a project risk.

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

Nested Schema : ApiEntityRiskQuantifiedOtherImpact

Type: object

Show Source

link(optional): string(url)

Read Only: true
maximum(optional): number(double)

The maximum probability that a risk event will occur.
minimum(optional): number(double)

The minimum probability that a risk event will occur.
mostLikely(optional): number(double)

The most likely probability that a risk event will occur.
preOrPostResponse(optional): string

Allowed Values: [ "PRE_RESPONSE", "POST_RESPONSE" ]

Indicates whether a risk impact is measured pre or post response.
projectRiskId(optional): integer(int64)

The unique identifier of a project.
quantifiedOtherImpactId(optional): integer(int64)

The unique identifier of a risk impact.
scoreType(optional): string

Allowed Values: [ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]

The type of an impact score.
shape(optional): string

Allowed Values: [ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]

The distribution that best models the three-point estimates for risk probabilities.
updateDate(optional): string(date-time)

Read Only: true

Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "maximum":{
            "type":"number",
            "format":"double",
            "description":"The maximum probability that a risk event will occur."
        },
        "minimum":{
            "type":"number",
            "format":"double",
            "description":"The minimum probability that a risk event will occur."
        },
        "shape":{
            "type":"string",
            "description":"The distribution that best models the three-point estimates for risk probabilities.",
            "enum":[
                "NONE",
                "TRIANGLE",
                "UNIFORM",
                "GAUSSIAN",
                "SINGLE_POINT"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a project."
        },
        "mostLikely":{
            "type":"number",
            "format":"double",
            "description":"The most likely probability that a risk event will occur."
        },
        "scoreType":{
            "type":"string",
            "description":"The type of an impact score.",
            "enum":[
                "PROBABILITY",
                "SCHEDULE",
                "RELATIVE_SCHEDULE",
                "COST",
                "RELATIVE_COST",
                "USER"
            ]
        },
        "preOrPostResponse":{
            "type":"string",
            "description":"Indicates whether a risk impact is measured pre or post response.",
            "enum":[
                "PRE_RESPONSE",
                "POST_RESPONSE"
            ]
        },
        "quantifiedOtherImpactId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a risk impact."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Batch Update Project Risks

Request

Response

200 Response

400 Response