Jump to

• Request
• Response

Batch Sync Programs

post

/api/restapi/program/syncBatch

Send a request to this endpoint to create or update one or more programs. This endpoint should to be used to sync programs under a single workspace.

Request

Header Parameters

• singleTransaction:
  Enabling this boolean flag will fail the request if an error occurs while processing any program sent as part of the request.
  Allowed Values: [ "true", "false" ]

  Default Value: false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityProgramInput>

Type: array

Title: List<ApiEntityProgramInput>

Show Source

• Array of: object ApiEntityProgramInput
  Title: ApiEntityProgramInput

  This entity represents a Program object, a unique Program object can be identified by the following combinations of the fields.

  • programId
  • programCode, workspaceId
  • programCode, workspaceCode

{
    "title":"List<ApiEntityProgramInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProgramInput

Type: object

Title: ApiEntityProgramInput

This entity represents a Program object, a unique Program object can be identified by the following combinations of the fields.

• programId
• programCode, workspaceId
• programCode, workspaceCode

Show Source

• actualFinish: string (date-time)
  The Actual Finish displays the date on which a program is considered complete.
  This value can be entered manually or can be imported.
• actualsLinkType: string
  Maximum Length: 255

  The field source for the actuals curve in cash flow.
• actualStart: string (date-time)
  The Actual Start indicates the date work on the program began.
  This value can be entered manually or can be imported.
• benefitsFinishDate: string (date-time)
  The date benefits on the program finished.
• benefitsLinkType: string
  Maximum Length: 255

  The field source for the benefit curve in cash flow.
• benefitsStartDate: string (date-time)
  The date benefits on the program began.
• breakdownCapitalForActual: boolean
  Enables you breakdown spends total into spends capital.
• breakdownCapitalForForecast: boolean
  Enables you breakdown forecast total into forecast capital.
• breakdownCapitalForPlannedBudget: boolean
  Enables you breakdown planned budget total into planned budget capital.
• breakdownExpenseForActual: boolean
  Enables you breakdown spends total into spends expense.
• breakdownExpenseForForecast: boolean
  Enables you breakdown forecast total into forecast expense.
• breakdownExpenseForPlannedBudget: boolean
  Enables you breakdown planned budget total into planned budget expense.
• businessImpact: string
  Maximum Length: 4000

  A detailed description of the business impact of the program.
• codeValues: array codeValues
  The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.
• configuredFields: array configuredFields
  The list of configured fields for a program.
• createDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.5.
  The date the program was added.
• createUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.5.
  The user who added the program.
• description: string
  Maximum Length: 4000

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

  Deprecated. As of 23.5.
  The unique identifier for the program evaluation.
• evaluationScore: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.
• forecastFinishDate: string (date-time)
  The planned finish date of a program's remaining Forecast cost.
• forecastLinkType: string
  Maximum Length: 255

  The field source for the forecast curve in cash flow.
• forecastStartDate: string (date-time)
  The planned start date of a program's remaining Forecast cost.
• lastProgramEvaluationDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.5.
  The most recent evaluation date for the program.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• linkedObjects: array linkedObjects
  The list of projects linked to the program.
• linkForecastToSpend: boolean
  Enables you to link program Forecast data to program Actuals data.
  When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.
• owner: string
  Maximum Length: 255

  The manager or person responsible for the program.
• plannedBudgetLinkType: string
  Maximum Length: 255

  The field source for the planned budget curve in cash flow.
• plannedFinish: string (date-time)
  The finish date for the time phased Planned Budget of the program.
  Planned Budget cost spread will adjust when this date is changed.
• plannedStart: string (date-time)
  The start date for the time phased Planned Budget of the program.
  Planned Budget cost spread will adjust when this date is changed.
  The Program Planned Start also represents the earliest date that activities can occur within a program schedule.
• problemOrOpportunity: string
  Maximum Length: 4000

  A detailed description of the problem or opportunity the program addresses.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programFinancial: programFinancial
  The financial fields associated with a program.
• programId: integer (int64)
  The unique identifier for the program.
• programName(required): string
  Maximum Length: 255

  The name of the program.
• programPhaseFinancials: array programPhaseFinancials
  The program cashflow data associated with the program.
• programSettings: array programSettings
  The program settings associated with the program.
• riskMatrixId: integer (int64)
  The risk matrix assigned to the program for calculating program risk scores.
• spendEffectiveDate: string (date-time)
  The month in which an actuals value was last added to the program
• spendFinishDate: string (date-time)
  The finish date for the program actuals.
• spendStartDate: string (date-time)
  The start date for the program actuals.
• status: string
  Allowed Values: [ "PLANNED", "ACTIVE", "INACTIVE", "ON_HOLD", "COMPLETE" ]

  The current status of the program.
• statusDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.5.
  The date and time the program status was changed.
• strategicObjective: string
  Maximum Length: 4000

  A detailed description of the strategic object of the program.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• updateUser: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.5.
  The user who last modified the program
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityProgramInput",
    "required":[
        "programName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "owner":{
            "maxLength":"255",
            "type":"string",
            "description":"The manager or person responsible for the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The current status of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PLANNED",
                "ACTIVE",
                "INACTIVE",
                "ON_HOLD",
                "COMPLETE"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"The detailed summary for the program. The description provides more information than short names or titles. It can give background information or establish a purpose for the item. These details help differentiate between items with similar names and are especially useful in multi-user environments.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spendStartDate":{
            "type":"string",
            "description":"The start date for the program actuals.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The user who last modified the program",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The date the program was added.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createUser":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The user who added the program.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueProgramInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "evaluationMatrixId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The unique identifier for the program evaluation.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedStart":{
            "type":"string",
            "description":"The start date for the time phased Planned Budget of the program. <br />Planned Budget cost spread will adjust when this date is changed. <br />The Program Planned Start also represents the earliest date that activities can occur within a program schedule.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedFinish":{
            "type":"string",
            "description":"The finish date for the time phased Planned Budget of the program. <br />Planned Budget cost spread will adjust when this date is changed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualStart":{
            "type":"string",
            "description":"The Actual Start indicates the date work on the program began. <br />This value can be entered manually or can be imported.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualFinish":{
            "type":"string",
            "description":"The Actual Finish displays the date on which a program is considered complete. <br />This value can be entered manually or can be imported.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "problemOrOpportunity":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the problem or opportunity the program addresses.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "businessImpact":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the business impact of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategicObjective":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the strategic object of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastFinishDate":{
            "type":"string",
            "description":"The planned finish date of a program's remaining Forecast cost.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastStartDate":{
            "type":"string",
            "description":"The planned start date of a program's remaining Forecast cost.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spendFinishDate":{
            "type":"string",
            "description":"The finish date for the program actuals.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsStartDate":{
            "type":"string",
            "description":"The date benefits on the program began.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsFinishDate":{
            "type":"string",
            "description":"The date benefits on the program finished.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "evaluationScore":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "lastProgramEvaluationDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The most recent evaluation date for the program.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskMatrixId":{
            "type":"integer",
            "description":"The risk matrix assigned to the program for calculating program risk scores.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "spendEffectiveDate":{
            "type":"string",
            "description":"The month in which an actuals value was last added to the program ",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "linkForecastToSpend":{
            "type":"boolean",
            "description":"Enables you to link program Forecast data to program Actuals data. <br />When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "linkedObjects":{
            "type":"array",
            "description":"The list of projects linked to the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramLinkedObjectInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "actualsLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the actuals curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the forecast curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedBudgetLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the planned budget curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the benefit curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The date and time the program status was changed.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "breakdownCapitalForPlannedBudget":{
            "type":"boolean",
            "description":"Enables you breakdown planned budget total into planned budget capital.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownExpenseForPlannedBudget":{
            "type":"boolean",
            "description":"Enables you breakdown planned budget total into planned budget expense.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownCapitalForActual":{
            "type":"boolean",
            "description":"Enables you breakdown spends total into spends capital.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownExpenseForActual":{
            "type":"boolean",
            "description":"Enables you breakdown spends total into spends expense.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownCapitalForForecast":{
            "type":"boolean",
            "description":"Enables you breakdown forecast total into forecast capital.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "breakdownExpenseForForecast":{
            "type":"boolean",
            "description":"Enables you breakdown forecast total into forecast expense.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "programSettings":{
            "type":"array",
            "description":"The program settings associated with the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramSettingInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programPhaseFinancials":{
            "type":"array",
            "description":"The program cashflow data associated with the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramPhaseFinancialInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programFinancial":{
            "description":"The financial fields associated with a program.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramFinancialInput"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a Program object, a unique Program object can be identified by the following combinations of the fields.<ul><li>programId</li><li>programCode, workspaceId</li><li>programCode, workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : codeValues

Type: array

The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueProgramInput
  Title: ApiEntityCodeValueProgramInput

  This entity represents a CodeValueProgram object, a unique CodeValueProgram object can be identified by the following combinations of the fields.

  • codeValueObjectId
  • codeTypeCode, codeValueCode
  • codeTypeId,codeValueCode
  • codeValueId
  • codeValueCode,codeTypeCode,parentId
  • codeValueCode,codeTypeId,parentId

{
    "type":"array",
    "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueProgramInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a program.

Show Source

• Array of: object ApiEntityProgramConfiguredFieldValueInput
  Title: ApiEntityProgramConfiguredFieldValueInput

  This entity represents a ProgramConfiguredFieldValue object, a unique ProgramConfiguredFieldValue object can be identified by the following combinations of the fields.

  • configuredFieldObjectId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for a program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : linkedObjects

Type: array

The list of projects linked to the program.

Show Source

• Array of: object ApiEntityProgramLinkedObjectInput
  Title: ApiEntityProgramLinkedObjectInput

  This entity represents a ProgramLinkedObject object, a unique ProgramLinkedObject object can be identified by the following combinations of the fields.

  • objectId, objectType

{
    "type":"array",
    "description":"The list of projects linked to the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramLinkedObjectInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : programFinancial

The financial fields associated with a program.

Match All

Show Source

• object ApiEntityProgramFinancialInput
  Title: ApiEntityProgramFinancialInput

{
    "description":"The financial fields associated with a program.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProgramFinancialInput"
        }
    ]
}

Nested Schema : programPhaseFinancials

Type: array

The program cashflow data associated with the program.

Show Source

• Array of: object ApiEntityProgramPhaseFinancialInput
  Title: ApiEntityProgramPhaseFinancialInput

  This entity represents a ProgramPhaseFinancial object, a unique ProgramPhaseFinancial object can be identified by the following combinations of the fields.

  • programPhaseFinancialId

{
    "type":"array",
    "description":"The program cashflow data associated with the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramPhaseFinancialInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : programSettings

Type: array

The program settings associated with the program.

Show Source

• Array of: object ApiEntityProgramSettingInput
  Title: ApiEntityProgramSettingInput

{
    "type":"array",
    "description":"The program settings associated with the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramSettingInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueProgramInput

Type: object

Title: ApiEntityCodeValueProgramInput

This entity represents a CodeValueProgram object, a unique CodeValueProgram object can be identified by the following combinations of the fields.

• codeValueObjectId
• codeTypeCode, codeValueCode
• codeTypeId,codeValueCode
• codeValueId
• codeValueCode,codeTypeCode,parentId
• codeValueCode,codeTypeId,parentId

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The ID for the code type.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueObjectId: integer (int64)
  The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• programId: integer (int64)
  The unique identifier for the program.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueProgramInput",
    "required":[
        "codeTypeId",
        "codeValueCode",
        "codeValueName"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The ID for the code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueObjectId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueProgram object, a unique CodeValueProgram object can be identified by the following combinations of the fields.<ul><li>codeValueObjectId</li><li>codeTypeCode, codeValueCode</li><li>codeTypeId,codeValueCode</li><li>codeValueId</li><li>codeValueCode,codeTypeCode,parentId</li><li>codeValueCode,codeTypeId,parentId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramConfiguredFieldValueInput

Type: object

Title: ApiEntityProgramConfiguredFieldValueInput

This entity represents a ProgramConfiguredFieldValue object, a unique ProgramConfiguredFieldValue object can be identified by the following combinations of the fields.

• configuredFieldObjectId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• configuredFieldObjectId: integer (int64)
  The unique identifier for the Program Configured Field.
• costValue: number
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Read Only: true

  Deprecated. As of 23.10.
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• programId: integer (int64)
  The system-generated identifier of a Program.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The system-generated identifier of a Program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "configuredFieldObjectId":{
            "type":"integer",
            "description":"The unique identifier for the Program Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a ProgramConfiguredFieldValue object, a unique ProgramConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>configuredFieldObjectId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramLinkedObjectInput

Type: object

Title: ApiEntityProgramLinkedObjectInput

This entity represents a ProgramLinkedObject object, a unique ProgramLinkedObject object can be identified by the following combinations of the fields.

• objectId, objectType

Show Source

• action: string
  Allowed Values: [ "DELETE" ]
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• objectId: integer (int64)
  The system-generated identifier of a program linked object.
• objectType: string
  Maximum Length: 255

  The type of linked object.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramLinkedObjectInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "objectType":{
            "maxLength":"255",
            "type":"string",
            "description":"The type of linked object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "objectId":{
            "type":"integer",
            "description":"The system-generated identifier of a program linked object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProgramLinkedObject object, a unique ProgramLinkedObject object can be identified by the following combinations of the fields.<ul><li>objectId, objectType</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramFinancialInput

Type: object

Title: ApiEntityProgramFinancialInput

Show Source

• actualCapitalCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of actual expense cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCapitalCostPresentValue: number (double)
  Deprecated. As of 23.5.
  The capital present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• actualCapitalCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of actual expense cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualCostPresentValue: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The present value, also known as discounted value, of the overall program actuals. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
• actualCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of actual cost currently allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualExpenseCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of actual capital cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• actualExpenseCostPresentValue: number (double)
  Deprecated. As of 23.5.
  The expense present value, also known as discounted value, of the overall program actuals.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• actualExpenseCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of actual capital cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• annualDiscountRate: number (double)
  Minimum Value: 0

  Maximum Value: 1

  The interest rate associated with the cost of an investment from your commercial bank or another funding source.
  For example, an annual growth rate of an investment such as 4.75% can be used as an annual discount rate. This rate is used when a future value is assumed and you are trying to find the required Net Present Value.
  This value can be entered manually or can be imported.
• benefits: number (double)
  Deprecated. As of 23.5.
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
• benefitsCOR: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This is an input field, will not be a part of response.
• benefitsDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of benefits currently allocated across the program timescale.
• benefitsOutOfSync: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether the Benefits roll-up from projects is out of sync.
• benefitsPresentValue: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
• benefitsUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of benefits that have not been allocated across the program timescale.
• costPerfIndex: number (double)
  The measure of a program's cost efficiency.
  A value of less than 1 indicates the program is over budget, while a value greater than 1 indicates the program is under budget.
  This value can be entered manually or can be imported.
• costVariance: number (double)
  Deprecated. As of 23.5.
  The measure of cost performance on a program.
  A negative value indicates that the Actual Cost has exceeded the planned value.
  This value can be entered manually or can be imported.
• costVarianceCOR: number (double)
  The measure of cost performance on a program.
  A negative value indicates that the Actual Cost has exceeded the planned value.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• earnedValueCost: number (double)
  Deprecated. As of 23.5.
  The value of work performed on a program in reference to the approved budget for the program.
  The cost value used for the Earned Value Management of a program.
  Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
  This value can be entered manually or can be imported.
• earnedValueCostCOR: number (double)
  The value of work performed on a program in reference to the approved budget for the program.
  The cost value used for the Earned Value Management of a program.
  Earned Value Management allows program managers to quantify program progress and objectively measure a program's success.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• estAtCompleteCost: number (double)
  Deprecated. As of 23.5.
  The expected total cost of the program when the defined scope of work will be completed.
  This value can be entered manually or can be imported.
• estAtCompleteCostCOR: number (double)
  The expected total cost of the program when the defined scope of work will be completed.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• estToCompleteCost: number (double)
  Deprecated. As of 23.5.
  The estimated cost needed to complete the program.
  This value can be entered manually or can be imported.
• estToCompleteCostCOR: number (double)
  The estimated cost needed to complete the program.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• forecastCapitalCost: number (double)
  Deprecated. As of 23.5.
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostCOR: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastCapitalCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of forecast cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostPresentValue: number (double)
  Deprecated. As of 23.5.
  The capital present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of forecast cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastCost: number (double)
  Deprecated. As of 23.5.
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
• forecastCostCOR: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of forecast cost currently allocated across the program timescale.
• forecastCostPresentValue: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The present value, also known as the discounted value, of the overall program forecast. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
• forecastCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of forecast cost unallocated across the program timescale.
• forecastExpenseCost: number (double)
  Deprecated. As of 23.5.
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostCOR: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastExpenseCostDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The expense amount of forecast cost allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostPresentValue: number (double)
  Deprecated. As of 23.5.
  The expense present value, also known as the discounted value, of the overall program forecast.
  Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The expense amount of forecast cost unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• forecastOutOfSync: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether the Forecast roll-up from projects is out of sync.
• intRateOfReturn: number (double)
  The quantitative measurement used to compare the profitability of program investments.
  The rate at which investors will receive returns on their investments in a program.
  This value can be entered manually or can be imported.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• netPresentValue: number (double)
  Deprecated. As of 23.5.
  The difference between the present value (PV) of the future cash flows from current investments and program costs.
  The Net Present Value accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
  Positive Net Present Value (NPV) is an indicator of programs that should be pursued.
  This value can be entered manually or can be imported.
• netPresentValueCOR: number (double)
  The difference between the Present Value (PV) of the future cash flows from current investments and program costs.
  The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital.
  A positive NPV is an indicator of programs that should be pursued.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• paybackPeriod: 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 program.
  
  
  This value can be entered manually or can be imported.
• plannedBudget: number (double)
  Deprecated. As of 23.5.
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
• plannedBudgetCapital: number (double)
  Deprecated. As of 23.5.
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalCOR: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetCapitalDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of planned budget allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalPresentValue: number (double)
  Deprecated. As of 23.5.
  The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The capital amount of planned budget unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCOR: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of planned budget allocated across the program timescale.
• plannedBudgetExpense: number (double)
  Deprecated. As of 23.5.
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseCOR: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetExpenseDistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The expense amount of planned budget allocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpensePresentValue: number (double)
  Deprecated. As of 23.5.
  The expense present value, also known as the discounted value, of the overall program planned budget.
  Future cash flows are discounted using the program's annual discount rate.
  Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The expense amount of planned budget unallocated across the program timescale.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetOutOfSync: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether the Planned Budget roll-up from projects is out of sync.
• plannedBudgetPresentValue: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.
• plannedBudgetUndistributed: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The amount of planned budget unallocated across the program timescale.
• plannedValueCost: number (double)
  Deprecated. As of 23.5.
  The amount of approved capital spent on a scheduled portion of work on a program.
  Planned Value Cost is often used for Earned Value Management.
  This value can be entered manually or can be imported.
• plannedValueCostCOR: number (double)
  The amount of approved capital spent on a scheduled portion of work on a program.
  Planned Value Cost is often used for Earned Value Management.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• profitabilityIndex: number (double)
  The index based on the value of a program's present values divided by initial program investments.
• programId: integer (int64)
  The unique identifier for a program set by the user who created the program.
• returnOnInvestment: number (double)
  The percentage resulting from division of the expected returns of an investment by the investment costs of a program or portfolio.
  For example, a program is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%.
  This value can be entered manually or can be imported.
• schedPerfIndex: number (double)
  The measure of the work accomplished as a percentage of the work scheduled on a program.
  Schedule Performance Index indicates whether you are meeting earned and planned values within your program schedule.
  A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the program is ahead of schedule.
  This value can be entered manually or can be imported.
• scheduleVariance: number (double)
  Deprecated. As of 23.5.
  The measure of schedule performance on a program.
  A negative value indicates that less work was actually performed than was scheduled.
  This value can be entered manually or can be imported.
• scheduleVarianceCOR: number (double)
  The measure of schedule performance on a program.
  A negative value indicates that less work was actually performed than was scheduled.
  This value can be entered manually or can be imported.
  This is an input field, will not be a part of response.
• spendCapitalCost: number (double)
  Deprecated. As of 23.5.
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendCapitalCostCOR: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendCost: number (double)
  Deprecated. As of 23.5.
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
• spendCostCOR: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendExpenseCost: number (double)
  Deprecated. As of 23.5.
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendExpenseCostCOR: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendForecastVar: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The total and time phased variance between the program's Actuals and Forecast.
• spendPlannedVariance: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The total and time phased variance between the program's Actuals and Planned Budget.
• spendsOutOfSync: boolean
  Read Only: true

  Deprecated. As of 23.11.
  Indicates whether the Actuals roll-up from projects is out of sync.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• yearEndForecastCost: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  Total forecast at the end of year actuals till date, with respect to the current year.
• ytdSpendCost: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.

{
    "title":"ApiEntityProgramFinancialInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "estToCompleteCostCOR":{
            "type":"number",
            "description":"The estimated cost needed to complete the program. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCostCOR":{
            "type":"number",
            "description":"The amount of approved capital spent on a scheduled portion of work on a program. <br />Planned Value Cost is often used for Earned Value Management. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scheduleVarianceCOR":{
            "type":"number",
            "description":"The measure of schedule performance on a program. <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. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "netPresentValueCOR":{
            "type":"number",
            "description":"The difference between the Present Value (PV) of the future cash flows from current investments and program costs. <br />The Net Present Value (NPV) accounts for changes in inflation and returns when calculating the difference in value of incoming and outgoing capital. <br />A positive NPV is an indicator of programs that should be pursued. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "benefitsCOR":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalCOR":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseCOR":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostCOR":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostCOR":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostCOR":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostCOR":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCOR":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostCOR":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostCOR":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costVarianceCOR":{
            "type":"number",
            "description":"The measure of cost performance on a program. <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. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "earnedValueCostCOR":{
            "type":"number",
            "description":"The value of work performed on a program in reference to the approved budget for the program. <br />The cost value used for the Earned Value Management of a program. <br />Earned Value Management allows program managers to quantify program progress and objectively measure a program's success. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "estAtCompleteCostCOR":{
            "type":"number",
            "description":"The expected total cost of the program when the defined scope of work will be completed. <br />This value can be entered manually or can be imported. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedValueCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of approved capital spent on a scheduled portion of work on a program. <br />Planned Value Cost is often used for Earned Value Management. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "earnedValueCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The value of work performed on a program in reference to the approved budget for the program. <br />The cost value used for the Earned Value Management of a program. <br />Earned Value Management allows program managers to quantify program progress and objectively measure a program's success. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costVariance":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The measure of cost performance on a program. <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.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCapitalCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of actual expense cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualExpenseCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of actual capital cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of actual cost currently allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCapitalCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of actual expense cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualExpenseCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of actual capital cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of actual cost currently allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of planned budget allocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudget":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of planned budget unallocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The present value, also known as the discounted value, of the overall program planned budget. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of forecast cost currently allocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of forecast cost unallocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The present value, also known as the discounted value, of the overall program forecast. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The present value, also known as discounted value, of the overall program actuals. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendForecastVar":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total and time phased variance between the program's Actuals and Forecast.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendPlannedVariance":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total and time phased variance between the program's Actuals and Planned Budget.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "yearEndForecastCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>Total forecast at the end of year actuals till date, with respect to the current year.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "ytdSpendCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>A measurement of capital spent on a program 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 program over the current Period Year.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "estAtCompleteCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expected total cost of the program when the defined scope of work will be completed. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "estToCompleteCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The estimated cost needed to complete the program. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "scheduleVariance":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The measure of schedule performance on a program. <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.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "netPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The difference between the present value (PV) of the future cash flows from current investments and program 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 programs that should be pursued. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefits":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefitsDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of benefits currently allocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefitsUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The amount of benefits that have not been allocated across the program timescale.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefitsPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The present value, also known as the discounted value, of the overall program benefits. Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapital":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of planned budget unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital present value, also known as the discounted value, of the overall program planned budget.Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpense":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The  expense amount of planned budget unallocated across the program timescale.  <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpensePresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense present value, also known as the discounted value, of the overall program planned budget. <br />Future cash flows are discounted using the program's annual discount rate. <br />Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of forecast cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of forecast cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCostDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense amount of forecast cost allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCostUndistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense amount of forecast cost unallocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense present value, also known as the discounted value, of the overall program forecast. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use the present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendCapitalCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendExpenseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualCapitalCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualExpenseCostPresentValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense present value, also known as discounted value, of the overall program actuals. <br />Future cash flows are discounted using the program's annual discount rate. Portfolio managers can use present value of a program's expected cash flow as a metric during program prioritization and selection. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The capital amount of planned budget allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseDistributed":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The expense amount of planned budget allocated across the program timescale. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for a program set by the user who created the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costPerfIndex":{
            "type":"number",
            "description":"The measure of a program's cost efficiency. <br />A value of less than 1 indicates the program is over budget, while a value greater than 1 indicates the program is under budget. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "schedPerfIndex":{
            "type":"number",
            "description":"The measure of the work accomplished as a percentage of the work scheduled on a program. <br />Schedule Performance Index indicates whether you are meeting earned and planned values within your program schedule. <br />A value less than 1 indicates that less work was performed than was scheduled. A value greater than 1 indicates the program is ahead of schedule. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "paybackPeriod":{
            "type":"number",
            "description":"The estimate of the length of time that will transpire before net profits recover the initial and periodic costs of an investment to carry out the selected program. <br /><br /><br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "profitabilityIndex":{
            "type":"number",
            "description":"The index based on the value of a program's present values divided by initial program investments.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "returnOnInvestment":{
            "type":"number",
            "description":"The percentage resulting from division of the expected returns of an investment by the investment costs of a program or portfolio. <br />For example, a program is expected to cost 1.0 million dollars with a total benefit of 1.2 million dollars. Its Net Present Value is $200,000. The Return on Investment is 20%. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetOutOfSync":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether the Planned Budget roll-up from projects is out of sync.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "forecastOutOfSync":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether the Forecast roll-up from projects is out of sync.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "spendsOutOfSync":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether the Actuals roll-up from projects is out of sync.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "benefitsOutOfSync":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether the Benefits roll-up from projects is out of sync.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "annualDiscountRate":{
            "maximum":"1",
            "minimum":"0",
            "type":"number",
            "description":"The interest rate associated with the cost of an investment from your commercial bank or another funding source. <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.",
            "format":"double",
            "exampleSetFlag":false
        },
        "intRateOfReturn":{
            "type":"number",
            "description":"The quantitative measurement used to compare the profitability of program investments. <br />The rate at which investors will receive returns on their investments in a program. <br />This value can be entered manually or can be imported.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramPhaseFinancialInput

Type: object

Title: ApiEntityProgramPhaseFinancialInput

This entity represents a ProgramPhaseFinancial object, a unique ProgramPhaseFinancial object can be identified by the following combinations of the fields.

• programPhaseFinancialId

Show Source

• benefits: number (double)
  Deprecated. As of 23.5.
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
• benefitsCOR: number (double)
  Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.
  This is an input field, will not be a part of response.
• forecastCapitalCost: number (double)
  Deprecated. As of 23.5.
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastCapitalCostCOR: number (double)
  The total capital estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastCost: number (double)
  Deprecated. As of 23.5.
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
• forecastCostCOR: number (double)
  The total estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• forecastExpenseCost: number (double)
  Deprecated. As of 23.5.
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This value is based on the base currency with specified exchange rate.
• forecastExpenseCostCOR: number (double)
  The total expense estimation of a program's remaining costs.
  Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.
  This is an input field, will not be a part of response.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• month: integer (int32)
  The time period during which budget planning for the program takes place in months.
• phaseStartDate: string (date-time)
  The starting date for a time phase of the program life cycle.
• plannedBudget: number (double)
  Deprecated. As of 23.5.
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
• plannedBudgetCapital: number (double)
  Deprecated. As of 23.5.
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetCapitalCOR: number (double)
  The planned total capital cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetCOR: number (double)
  The planned total cost of a program as defined by the program manager.
  Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• plannedBudgetExpense: number (double)
  Deprecated. As of 23.5.
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This value is based on the base currency with specified exchange rate.
• plannedBudgetExpenseCOR: number (double)
  The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.
  This is an input field, will not be a part of response.
• programId: integer (int64)
  The unique identifier for a program set by the user who created the program.
• programPhaseFinancialId: integer (int64)
  The system-generated identifier of a progam phase financial.
• spendCapitalCost: number (double)
  Deprecated. As of 23.5.
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendCapitalCostCOR: number (double)
  The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendCost: number (double)
  Deprecated. As of 23.5.
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
• spendCostCOR: number (double)
  The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendExpenseCost: number (double)
  Deprecated. As of 23.5.
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This value is based on the base currency with specified exchange rate.
• spendExpenseCostCOR: number (double)
  The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals.
  Actuals cannot be edited if a program has a status of Proposal.
  This is an input field, will not be a part of response.
• spendForecastVar: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The total and time phased variance between the program's Actuals and Forecast.
• spendPlannedVariance: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  The total and time phased variance between the program's Actuals and Planned Budget.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• year: integer (int32)
  The time period during which budget planning for the program takes place in years.
• yearEndForecastCost: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  Total forecast at the end of year actuals till date, with respect to the current year.
• ytdSpendCost: number (double)
  Read Only: true

  Deprecated. As of 23.5.
  A measurement of capital spent on a program starting from the beginning of the year up to the present date.
  YTD Actuals provides an overview of the total amount of actuals accrued on a program over the current Period Year.

{
    "title":"ApiEntityProgramPhaseFinancialInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsCOR":{
            "type":"number",
            "description":"Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCapitalCOR":{
            "type":"number",
            "description":"The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetExpenseCOR":{
            "type":"number",
            "description":"The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCapitalCostCOR":{
            "type":"number",
            "description":"The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastExpenseCostCOR":{
            "type":"number",
            "description":"The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCapitalCostCOR":{
            "type":"number",
            "description":"The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendExpenseCostCOR":{
            "type":"number",
            "description":"The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudgetCOR":{
            "type":"number",
            "description":"The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "forecastCostCOR":{
            "type":"number",
            "description":"The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "spendCostCOR":{
            "type":"number",
            "description":"The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This is an input field, will not be a part of response.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedBudget":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendForecastVar":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total and time phased variance between the program's Actuals and Forecast.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendPlannedVariance":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total and time phased variance between the program's Actuals and Planned Budget.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "yearEndForecastCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>Total forecast at the end of year actuals till date, with respect to the current year.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "ytdSpendCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>A measurement of capital spent on a program 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 program over the current Period Year.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "benefits":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>Program benefits is the income or positive cash flow from which all charges, costs, and expenses are subtracted to arrive at the net income. Also called sales, turnover, or revenue.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetCapital":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total capital cost of a program as defined by the program manager. <br />Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "plannedBudgetExpense":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The planned total expense cost of a program as defined by the program manager.Planners can use Planned Budgets to determine how to allocate a plan's Proposed Budget values to programs, as well as what programs are reasonable to include in the current portfolio budget plan. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastCapitalCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total capital estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "forecastExpenseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total expense estimation of a program's remaining costs. <br />Once programs have begun, program managers update the program forecast to represent remaining cost estimates for the duration of the program's life cycle. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendCapitalCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total capital amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "spendExpenseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.5</i>.</br>The total expense amount incurred on a program throughout its lifecycle, such as the costs of invoices, payments, or accruals. <br />Actuals cannot be edited if a program has a status of Proposal. <br />This value is based on the base currency with specified exchange rate.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "year":{
            "type":"integer",
            "description":"The time period during which budget planning for the program takes place in years.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "month":{
            "type":"integer",
            "description":"The time period during which budget planning for the program takes place in months.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for a program set by the user who created the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programPhaseFinancialId":{
            "type":"integer",
            "description":"The system-generated identifier of a progam phase financial.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "phaseStartDate":{
            "type":"string",
            "description":"The starting date for a time phase of the program life cycle.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProgramPhaseFinancial object, a unique ProgramPhaseFinancial object can be identified by the following combinations of the fields.<ul><li>programPhaseFinancialId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramSettingInput

Type: object

Title: ApiEntityProgramSettingInput

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• programId: integer (int64)
  The unique identifier of a program.
• programSettingId: integer (int64)
  The unique identifier of a program setting. This value should not be provided in create operation request data, however, it is required for update requests.
• settingName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of a program setting.
• settingValue: string
  Minimum Length: 0

  Maximum Length: 4000

  Value of a program setting.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramSettingInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier of a program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programSettingId":{
            "type":"integer",
            "description":"The unique identifier of a program setting. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "settingName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of a program setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "settingValue":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Value of a program setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Create or Update a Programs Create or Update a Program Using Code Value

Back to Top

Response

Supported Media Types

• application/json

207 Response

The object was successfully integrated.

Body ()

Root Schema : List<ApiEntitySyncApiResponse>

Type: array

Title: List<ApiEntitySyncApiResponse>

Show Source

• Array of: object ApiEntitySyncApiResponse
  Title: ApiEntitySyncApiResponse

{
    "title":"List<ApiEntitySyncApiResponse>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntitySyncApiResponse",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntitySyncApiResponse

Type: object

Title: ApiEntitySyncApiResponse

Show Source

• identifier: object identifier
  The unique identifier of the supported object returned based on the user input.
  This field can return any of the following entities determined based on the object for which the API call is invoked.
  Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• message: string
  Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.
• statusCode: integer (int32)
  The response code representing the state of the API operation.

{
    "title":"ApiEntitySyncApiResponse",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "message":{
            "type":"string",
            "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "identifier":{
            "type":"object",
            "description":"The unique identifier of the supported object returned based on the user input. <br />This field can return any of the following entities determined based on the object for which the API call is invoked. <br /><b>Example :</b> RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.",
            "exampleSetFlag":false,
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ConstraintIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CBSSheetSegmentIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CBSTemplateSegmentIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ScopeAssignmentActualsTimePhasedDataIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ScopeAssignmentInstalledTimePhasedDataIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ResourceWorkRateIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ReasonIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/WorkManagerTaskIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ChangeRequestIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ScopeItemAssignmentActivityIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RiskScoreTypeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RiskMatrixIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectRiskIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramRiskIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ActivityRiskIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RiskMitigationIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramRiskMitigationIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramRiskWeatherPeriodIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/HolidayGroupIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RiskWeatherPeriodIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/PortfolioIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/PortfolioMeasureIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/EntityReferenceIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/PortfolioMeasureManualValueIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CustomLogItemIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectRankIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectDependencyIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/LocationIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/MeasureIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/MeasureThresholdIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ReportCycleIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/UnitsOfMeasureIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/WorkspaceIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ApplicationUserGroupIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CalendarIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CodeTypeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CodeValueIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CostCategoryIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CurveIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/DocumentFolderStructureTemplateIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/IdeaIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/OfficeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectCompanyIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ResourceDemandIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectBudgetChangeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectBudgetTransferIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectResourceWorkRateIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectActualsLineItemIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectActualsIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectBudgetItemIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/StrategyIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/StrategyTypeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RuleOfCreditIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ResourceRoleAssignmentIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/BudgetPlanningScenarioIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ScopeAssignmentPlannedTimePhasedDataIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramBudgetTransferIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramBudgetChangeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ActivityIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/AssignmentIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RelationshipIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/FundActualIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramBudgetItemIdentifier",
                    "exampleSetFlag":false
                }
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The response code representing the state of the API operation.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : identifier

Type: object

The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.

Match One Schema

Show Source

• object ConstraintIdentifier
  Title: ConstraintIdentifier
• object CBSSheetSegmentIdentifier
  Title: CBSSheetSegmentIdentifier
• object CBSTemplateSegmentIdentifier
  Title: CBSTemplateSegmentIdentifier
• object ScopeAssignmentActualsTimePhasedDataIdentifier
  Title: ScopeAssignmentActualsTimePhasedDataIdentifier
• object ScopeAssignmentInstalledTimePhasedDataIdentifier
  Title: ScopeAssignmentInstalledTimePhasedDataIdentifier
• object ResourceWorkRateIdentifier
  Title: ResourceWorkRateIdentifier
• object ReasonIdentifier
  Title: ReasonIdentifier
• object WorkManagerTaskIdentifier
  Title: WorkManagerTaskIdentifier
• object ChangeRequestIdentifier
  Title: ChangeRequestIdentifier
• object ScopeItemAssignmentActivityIdentifier
  Title: ScopeItemAssignmentActivityIdentifier
• object RiskScoreTypeIdentifier
  Title: RiskScoreTypeIdentifier
• object RiskMatrixIdentifier
  Title: RiskMatrixIdentifier
• object ProjectRiskIdentifier
  Title: ProjectRiskIdentifier
• object ProgramRiskIdentifier
  Title: ProgramRiskIdentifier
• object ActivityRiskIdentifier
  Title: ActivityRiskIdentifier
• object RiskMitigationIdentifier
  Title: RiskMitigationIdentifier
• object ProgramRiskMitigationIdentifier
  Title: ProgramRiskMitigationIdentifier
• object ProgramRiskWeatherPeriodIdentifier
  Title: ProgramRiskWeatherPeriodIdentifier
• object HolidayGroupIdentifier
  Title: HolidayGroupIdentifier
• object RiskWeatherPeriodIdentifier
  Title: RiskWeatherPeriodIdentifier
• object PortfolioIdentifier
  Title: PortfolioIdentifier
• object PortfolioMeasureIdentifier
  Title: PortfolioMeasureIdentifier
• object EntityReferenceIdentifier
  Title: EntityReferenceIdentifier
• object PortfolioMeasureManualValueIdentifier
  Title: PortfolioMeasureManualValueIdentifier
• object CustomLogTypeObjectIdentifier
  Title: CustomLogTypeObjectIdentifier
• object CustomLogItemIdentifier
  Title: CustomLogItemIdentifier
• object ProjectRankIdentifier
  Title: ProjectRankIdentifier
• object ProjectDependencyIdentifier
  Title: ProjectDependencyIdentifier
• object LocationIdentifier
  Title: LocationIdentifier
• object MeasureIdentifier
  Title: MeasureIdentifier
• object MeasureThresholdIdentifier
  Title: MeasureThresholdIdentifier
• object ReportCycleIdentifier
  Title: ReportCycleIdentifier
• object UnitsOfMeasureIdentifier
  Title: UnitsOfMeasureIdentifier
• object WorkspaceIdentifier
  Title: WorkspaceIdentifier
• object ApplicationUserGroupIdentifier
  Title: ApplicationUserGroupIdentifier
• object CalendarIdentifier
  Title: CalendarIdentifier
• object CodeTypeIdentifier
  Title: CodeTypeIdentifier
• object CodeValueIdentifier
  Title: CodeValueIdentifier
• object CostCategoryIdentifier
  Title: CostCategoryIdentifier
• object CurveIdentifier
  Title: CurveIdentifier
• object DocumentFolderStructureTemplateIdentifier
  Title: DocumentFolderStructureTemplateIdentifier
• object IdeaIdentifier
  Title: IdeaIdentifier
• object OfficeIdentifier
  Title: OfficeIdentifier
• object ProjectCompanyIdentifier
  Title: ProjectCompanyIdentifier
• object ResourceDemandIdentifier
  Title: ResourceDemandIdentifier
• object ProjectBudgetChangeIdentifier
  Title: ProjectBudgetChangeIdentifier
• object ProjectBudgetTransferIdentifier
  Title: ProjectBudgetTransferIdentifier
• object ProjectResourceWorkRateIdentifier
  Title: ProjectResourceWorkRateIdentifier
• object ProjectActualsLineItemIdentifier
  Title: ProjectActualsLineItemIdentifier
• object ProjectActualsIdentifier
  Title: ProjectActualsIdentifier
• object ProjectBudgetItemIdentifier
  Title: ProjectBudgetItemIdentifier
• object ProgramIdentifier
  Title: ProgramIdentifier
• object StrategyIdentifier
  Title: StrategyIdentifier
• object StrategyTypeIdentifier
  Title: StrategyTypeIdentifier
• object RuleOfCreditIdentifier
  Title: RuleOfCreditIdentifier
• object ResourceRoleAssignmentIdentifier
  Title: ResourceRoleAssignmentIdentifier
• object BudgetPlanningScenarioIdentifier
  Title: BudgetPlanningScenarioIdentifier
• object ScopeAssignmentPlannedTimePhasedDataIdentifier
  Title: ScopeAssignmentPlannedTimePhasedDataIdentifier
• object ProgramBudgetTransferIdentifier
  Title: ProgramBudgetTransferIdentifier
• object ProgramBudgetChangeIdentifier
  Title: ProgramBudgetChangeIdentifier
• object ActivityIdentifier
  Title: ActivityIdentifier
• object AssignmentIdentifier
  Title: AssignmentIdentifier
• object RelationshipIdentifier
  Title: RelationshipIdentifier
• object FundActualIdentifier
  Title: FundActualIdentifier
• object ProgramBudgetItemIdentifier
  Title: ProgramBudgetItemIdentifier

{
    "type":"object",
    "description":"The unique identifier of the supported object returned based on the user input. <br />This field can return any of the following entities determined based on the object for which the API call is invoked. <br /><b>Example :</b> RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.",
    "exampleSetFlag":false,
    "oneOf":[
        {
            "$ref":"#/components/schemas/ConstraintIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CBSSheetSegmentIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CBSTemplateSegmentIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ScopeAssignmentActualsTimePhasedDataIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ScopeAssignmentInstalledTimePhasedDataIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ResourceWorkRateIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ReasonIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/WorkManagerTaskIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ChangeRequestIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ScopeItemAssignmentActivityIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RiskScoreTypeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RiskMatrixIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectRiskIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramRiskIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ActivityRiskIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RiskMitigationIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramRiskMitigationIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramRiskWeatherPeriodIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/HolidayGroupIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RiskWeatherPeriodIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/PortfolioIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/PortfolioMeasureIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/EntityReferenceIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/PortfolioMeasureManualValueIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CustomLogItemIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectRankIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectDependencyIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/LocationIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/MeasureIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/MeasureThresholdIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ReportCycleIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/UnitsOfMeasureIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/WorkspaceIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ApplicationUserGroupIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CalendarIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CodeTypeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CodeValueIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CostCategoryIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CurveIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/DocumentFolderStructureTemplateIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/IdeaIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/OfficeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectCompanyIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ResourceDemandIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectBudgetChangeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectBudgetTransferIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectResourceWorkRateIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectActualsLineItemIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectActualsIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectBudgetItemIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/StrategyIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/StrategyTypeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RuleOfCreditIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ResourceRoleAssignmentIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/BudgetPlanningScenarioIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ScopeAssignmentPlannedTimePhasedDataIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramBudgetTransferIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramBudgetChangeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ActivityIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/AssignmentIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RelationshipIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/FundActualIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramBudgetItemIdentifier",
            "exampleSetFlag":false
        }
    ]
}

Nested Schema : ConstraintIdentifier

Type: object

Title: ConstraintIdentifier

Show Source

• constraintCode(required): string
  The user specified identifier for a constraint.
• constraintId: integer (int64)
  The unique identifier of a constraint.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ConstraintIdentifier",
    "required":[
        "constraintCode"
    ],
    "type":"object",
    "properties":{
        "constraintId":{
            "type":"integer",
            "description":"The unique identifier of a constraint.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "constraintCode":{
            "type":"string",
            "description":"The user specified identifier for a constraint.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CBSSheetSegmentIdentifier

Type: object

Title: CBSSheetSegmentIdentifier

Show Source

• cbsSheetSegmentId: integer (int64)
  The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• segmentDefinitionName(required): string
  Maximum Length: 255

  The name of the level of the cost breakdown structure segment definition.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CBSSheetSegmentIdentifier",
    "required":[
        "segmentDefinitionName"
    ],
    "type":"object",
    "properties":{
        "cbsSheetSegmentId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "segmentDefinitionName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the level of the cost breakdown structure segment definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CBSTemplateSegmentIdentifier

Type: object

Title: CBSTemplateSegmentIdentifier

Show Source

• cbsTemplateSegmentId: integer (int64)
  The unique identifier for the CBS segment. This value should not be provided in create operation request data, however, it is required for update requests.
• segmentDefinitionName(required): string
  Maximum Length: 255

  The name of the CBS segment.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CBSTemplateSegmentIdentifier",
    "required":[
        "segmentDefinitionName"
    ],
    "type":"object",
    "properties":{
        "segmentDefinitionName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the CBS segment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cbsTemplateSegmentId":{
            "type":"integer",
            "description":"The unique identifier for the CBS segment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ScopeAssignmentActualsTimePhasedDataIdentifier

Type: object

Title: ScopeAssignmentActualsTimePhasedDataIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentActualsTimePhasedDataId: integer (int64)
  The unique identifier of scope actuals time phased data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignCode: string
  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ScopeAssignmentActualsTimePhasedDataIdentifier",
    "type":"object",
    "properties":{
        "scopeAssignmentActualsTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope actuals time phased data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ScopeAssignmentInstalledTimePhasedDataIdentifier

Type: object

Title: ScopeAssignmentInstalledTimePhasedDataIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentInstalledTimePhasedDataId: integer (int64)
  The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignCode: string
  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ScopeAssignmentInstalledTimePhasedDataIdentifier",
    "type":"object",
    "properties":{
        "scopeItemAssignCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeAssignmentInstalledTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ResourceWorkRateIdentifier

Type: object

Title: ResourceWorkRateIdentifier

Show Source

• effectiveStartDate: string (date-time)
  Date that the corresponding units/time period and rates go into effect for the resource or role.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• resourceWorkRateId: integer (int64)
  The system-generated identifier of the work rate.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.
• workspaceResourceId: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.

{
    "title":"ResourceWorkRateIdentifier",
    "type":"object",
    "properties":{
        "effectiveStartDate":{
            "type":"string",
            "description":"Date that the corresponding units/time period and rates go into effect for the resource or role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceWorkRateId":{
            "type":"integer",
            "description":"The system-generated identifier of the work rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceResourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ReasonIdentifier

Type: object

Title: ReasonIdentifier

Show Source

• reasonId: integer (int64)
  The unique identifier of a reason.
• reasonName: string
  Maximum Length: 255

  The name of the reason for recommitting to a task.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ReasonIdentifier",
    "type":"object",
    "properties":{
        "reasonId":{
            "type":"integer",
            "description":"The unique identifier of a reason.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "reasonName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the reason for recommitting to a task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : WorkManagerTaskIdentifier

Type: object

Title: WorkManagerTaskIdentifier

Show Source

• itemCode: string
  Maximum Length: 60

  The user-specified unique identifier assigned to the task.
• project: integer (int64)
  The unique identifier for the project.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• workManagerTaskId: integer (int64)
  The unique identifier for the resource or role.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"WorkManagerTaskIdentifier",
    "type":"object",
    "properties":{
        "project":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "itemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier assigned to the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workManagerTaskId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ChangeRequestIdentifier

Type: object

Title: ChangeRequestIdentifier

Show Source

• changeRequestCode: string
  Maximum Length: 60

  The user-specified unique identifier of the change request.
• changeRequestId: integer (int64)
  The unique identifier of the change request.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ChangeRequestIdentifier",
    "type":"object",
    "properties":{
        "changeRequestId":{
            "type":"integer",
            "description":"The unique identifier of the change request.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "changeRequestCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier of the change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ScopeItemAssignmentActivityIdentifier

Type: object

Title: ScopeItemAssignmentActivityIdentifier

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier for the activity.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeItemAssignmentActivityId: integer (int64)
  The system-generated identifier of a scope item.
• scopeItemAssignmentCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ScopeItemAssignmentActivityIdentifier",
    "type":"object",
    "properties":{
        "scopeItemAssignmentActivityId":{
            "type":"integer",
            "description":"The system-generated identifier of a scope item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignmentCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RiskScoreTypeIdentifier

Type: object

Title: RiskScoreTypeIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• riskScoreTypeId: integer (int64)
  The unique identifier of a score type.
• riskScoreTypeName: string
  Maximum Length: 255

  The name of the risk score type.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"RiskScoreTypeIdentifier",
    "type":"object",
    "properties":{
        "riskScoreTypeId":{
            "type":"integer",
            "description":"The unique identifier of a score type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreTypeName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the risk score type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RiskMatrixIdentifier

Type: object

Title: RiskMatrixIdentifier

Show Source

• matrixName: string
  Maximum Length: 60

  The name of the risk scoring matrix.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• riskMatrixId: integer (int64)
  The system-generated identifier of the risk matrix.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"RiskMatrixIdentifier",
    "type":"object",
    "properties":{
        "riskMatrixId":{
            "type":"integer",
            "description":"The system-generated identifier of the risk matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "matrixName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectRiskIdentifier

Type: object

Title: ProjectRiskIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProjectRiskIdentifier",
    "type":"object",
    "properties":{
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramRiskIdentifier

Type: object

Title: ProgramRiskIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• programRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramRiskIdentifier",
    "type":"object",
    "properties":{
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ActivityRiskIdentifier

Type: object

Title: ActivityRiskIdentifier

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier of an activity assigned to a risk.
• activityRiskId: integer (int64)
  The unique identifier for the activity.The activity object can also be identified by its unique criteria.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ActivityRiskIdentifier",
    "type":"object",
    "properties":{
        "activityId":{
            "type":"integer",
            "description":"The unique identifier of an activity assigned to a risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityRiskId":{
            "type":"integer",
            "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RiskMitigationIdentifier

Type: object

Title: RiskMitigationIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• riskMitigationCode: string
  Maximum Length: 60

  The unique identifier for the risk response action item.
• riskMitigationId: integer (int64)
  The system-generated identifier of a risk mitigation.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"RiskMitigationIdentifier",
    "type":"object",
    "properties":{
        "riskMitigationId":{
            "type":"integer",
            "description":"The system-generated identifier of a risk mitigation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskMitigationCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk response action item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramRiskMitigationIdentifier

Type: object

Title: ProgramRiskMitigationIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• programRiskId: integer (int64)
  The system-generated identifier of the project risk.
• programRiskMitigationCode: string
  Maximum Length: 60

  The unique identifier for the risk response action item.
• programRiskMitigationId: integer (int64)
  The system-generated identifier of a risk mitigation.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProgramRiskMitigationIdentifier",
    "type":"object",
    "properties":{
        "programRiskMitigationId":{
            "type":"integer",
            "description":"The system-generated identifier of a risk mitigation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programRiskMitigationCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk response action item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramRiskWeatherPeriodIdentifier

Type: object

Title: ProgramRiskWeatherPeriodIdentifier

Show Source

• periodName: string
  Maximum Length: 255

  The name of the period.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• programRiskId: integer (int64)
  The system-generated identifier of the project risk.
• programRiskWeatherPeriodId: integer (int64)
  The system-generated identifier for the period.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProgramRiskWeatherPeriodIdentifier",
    "type":"object",
    "properties":{
        "programRiskWeatherPeriodId":{
            "type":"integer",
            "description":"The system-generated identifier for the period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "periodName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the period.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : HolidayGroupIdentifier

Type: object

Title: HolidayGroupIdentifier

Show Source

• holidayGroupName: string
  Maximum Length: 60

  The name of the holiday list.
• holidayListId: integer (int64)
  The unique identifier for the holiday list.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"HolidayGroupIdentifier",
    "type":"object",
    "properties":{
        "holidayListId":{
            "type":"integer",
            "description":"The unique identifier for the holiday list.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayGroupName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday list.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RiskWeatherPeriodIdentifier

Type: object

Title: RiskWeatherPeriodIdentifier

Show Source

• periodName: string
  Maximum Length: 255

  The name of the period.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• riskWeatherPeriodId: integer (int64)
  The system-generated identifier for the period.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"RiskWeatherPeriodIdentifier",
    "type":"object",
    "properties":{
        "periodName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the period.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskWeatherPeriodId":{
            "type":"integer",
            "description":"The system-generated identifier for the period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : PortfolioIdentifier

Type: object

Title: PortfolioIdentifier

Show Source

• name: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the portfolio.
• portfolioId: integer (int64)
  The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"PortfolioIdentifier",
    "type":"object",
    "properties":{
        "name":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : PortfolioMeasureIdentifier

Type: object

Title: PortfolioMeasureIdentifier

Show Source

• measureId: integer (int64)
  The unique identifier of a portfolio measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• portfolioId: integer (int64)
  The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• portfolioMeasureId: integer (int64)
  The unique identifier of a portfolio measure.
• portfolioName: string
  Maximum Length: 255

  The name of the portfolio.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"PortfolioMeasureIdentifier",
    "type":"object",
    "properties":{
        "portfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : EntityReferenceIdentifier

Type: object

Title: EntityReferenceIdentifier

Show Source

• entityReferenceId: integer (int64)
  The system-generated identifier of a reference.

{
    "title":"EntityReferenceIdentifier",
    "type":"object",
    "properties":{
        "entityReferenceId":{
            "type":"integer",
            "description":"The system-generated identifier of a reference.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : PortfolioMeasureManualValueIdentifier

Type: object

Title: PortfolioMeasureManualValueIdentifier

Show Source

• beginDate: string (date-time)
  The start date of a portfolio.
• capitalPortfolioId: integer (int64)
  The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
• endDate: string (date-time)
  The end date of the portfolio.
• measureId: integer (int64)
  The unique identifier of a portfolio measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• portfolioMeasureManualValueId: integer (int64)
  The unique identifier of a portfolio measure.
• portfolioName: string
  Maximum Length: 255

  The name of the portfolio.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"PortfolioMeasureManualValueIdentifier",
    "type":"object",
    "properties":{
        "capitalPortfolioId":{
            "type":"integer",
            "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureManualValueId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "beginDate":{
            "type":"string",
            "description":"The start date of a portfolio.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The end date of the portfolio.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CustomLogTypeObjectIdentifier

Type: object

Title: CustomLogTypeObjectIdentifier

Show Source

• customLogTypeObjectId: integer (int64)
  The system-generated identifier of custom log type object.
• customLogTypeObjectName: string
  The user-defined identifier of a custom log type object.
• scope: string
  Maximum Length: 40

  Allowed Values: [ "project", "program", "workspace" ]

  The scope of an object.
• scopeCode: string
  The user-defined identifier of a reference to another object.
• scopeId: integer (int64)
  The system-generated identifier of a reference to another object.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CustomLogTypeObjectIdentifier",
    "type":"object",
    "properties":{
        "scopeId":{
            "type":"integer",
            "description":"The system-generated identifier of a reference to another object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "maxLength":"40",
            "type":"string",
            "description":"The scope of an object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "project",
                "program",
                "workspace"
            ]
        },
        "scopeCode":{
            "type":"string",
            "description":"The user-defined identifier of a reference to another object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectName":{
            "type":"string",
            "description":"The user-defined identifier of a custom log type object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectId":{
            "type":"integer",
            "description":"The system-generated identifier of custom log type object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CustomLogItemIdentifier

Type: object

Title: CustomLogItemIdentifier

Show Source

• customLogItemCode: string
  Maximum Length: 60

  A unique identifier unique of the custom log item.
• customLogItemId: integer (int64)
  The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.
• customLogTypeObjectId: integer (int64)
  The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.
• customLogTypeObjectName: string
  The user-specified identifier of a custom log type.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CustomLogItemIdentifier",
    "type":"object",
    "properties":{
        "customLogItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogItemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"A unique identifier unique of the custom log item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectName":{
            "type":"string",
            "description":"The user-specified identifier of a custom log type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectId":{
            "type":"integer",
            "description":"The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectRankIdentifier

Type: object

Title: ProjectRankIdentifier

Show Source

• evaluationCategoryId: integer (int64)
  Evaluation category ID.
• evaluationSubCategoryId: integer (int64)
  Evaluation subcategory ID.
• projectId: integer (int64)
  The system-generated identifier of the project.
• projectRankId: integer (int64)
  The system-generated identifier of the project rank.

{
    "title":"ProjectRankIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The system-generated identifier of the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRankId":{
            "type":"integer",
            "description":"The system-generated identifier of the project rank.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "evaluationCategoryId":{
            "type":"integer",
            "description":"Evaluation category ID.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "evaluationSubCategoryId":{
            "type":"integer",
            "description":"Evaluation subcategory ID.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectDependencyIdentifier

Type: object

Title: ProjectDependencyIdentifier

Show Source

• dependentProjectCode: string
  The project code of a project that has other projects that it relies on for support.
• dependentProjectId: integer (int64)
  The unique identifier of a project that has other projects that it relies on for support.
• dependentProjectWorkspaceCode: string
  The workspace code of a project that has other projects that it relies on for support.#project invalid inputs
• projectCode: string
  The project code of a project that has other projects depending on it.
• projectDependencyId: integer (int64)
  The unique identifier of a project dependency.
• projectId: integer (int64)
  The unique identifier of a project that has other projects depending on it.
• projectWorkspaceCode: string
  The workspace code of a project that has other projects depending on it.

{
    "title":"ProjectDependencyIdentifier",
    "type":"object",
    "properties":{
        "projectDependencyId":{
            "type":"integer",
            "description":"The unique identifier of a project dependency.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dependentProjectId":{
            "type":"integer",
            "description":"The unique identifier of a project that has other projects that it relies on for support.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dependentProjectCode":{
            "type":"string",
            "description":"The project code of a project that has other projects that it relies on for support.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectWorkspaceCode":{
            "type":"string",
            "description":"The workspace code of a project that has other projects depending on it.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dependentProjectWorkspaceCode":{
            "type":"string",
            "description":"The workspace code of a project that has other projects that it relies on for support.#project invalid inputs",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project that has other projects depending on it.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "type":"string",
            "description":"The project code of a project that has other projects depending on it.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : LocationIdentifier

Type: object

Title: LocationIdentifier

Show Source

• locationCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier of the location.
• locationId: integer (int64)
  The unique identifier for the location.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"LocationIdentifier",
    "type":"object",
    "properties":{
        "locationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "locationCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of the location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : MeasureIdentifier

Type: object

Title: MeasureIdentifier

Show Source

• measureId: integer (int64)
  The unique identifier of a measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"MeasureIdentifier",
    "type":"object",
    "properties":{
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : MeasureThresholdIdentifier

Type: object

Title: MeasureThresholdIdentifier

Show Source

• computeAgainstType: string
  Allowed Values: [ "ACTUAL_VALUE", "PERCENT_OF_TARGET" ]

  The against type of a threshold.
• desirableState: string
  Allowed Values: [ "HIGH_VALUES", "LOW_VALUES" ]

  The type of direction of a threshold.
• measureId: integer (int64)
  The unique identifier of a measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• measureThresholdId: integer (int64)
  The unique identifier of a threshold.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"MeasureThresholdIdentifier",
    "type":"object",
    "properties":{
        "measureThresholdId":{
            "type":"integer",
            "description":"The unique identifier of a threshold.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "computeAgainstType":{
            "type":"string",
            "description":"The against type of a threshold.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTUAL_VALUE",
                "PERCENT_OF_TARGET"
            ]
        },
        "desirableState":{
            "type":"string",
            "description":"The type of direction of a threshold.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "HIGH_VALUES",
                "LOW_VALUES"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ReportCycleIdentifier

Type: object

Title: ReportCycleIdentifier

Show Source

• cycleName: string
  Maximum Length: 255

  The name of the reporting cycle.
• reportCycleId: integer (int64)
  The unique identifier of a report cycle.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ReportCycleIdentifier",
    "type":"object",
    "properties":{
        "cycleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the reporting cycle.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "reportCycleId":{
            "type":"integer",
            "description":"The unique identifier of a report cycle.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : UnitsOfMeasureIdentifier

Type: object

Title: UnitsOfMeasureIdentifier

Show Source

• key: string
  Maximum Length: 60

  The abbreviation for the unit of measure name.
• unitOfMeasureId: integer (int64)
  The unique identifier for the unit of measure.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"UnitsOfMeasureIdentifier",
    "type":"object",
    "properties":{
        "key":{
            "maxLength":"60",
            "type":"string",
            "description":"The abbreviation for the unit of measure name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the unit of measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : WorkspaceIdentifier

Type: object

Title: WorkspaceIdentifier

Show Source

• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"WorkspaceIdentifier",
    "type":"object",
    "properties":{
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApplicationUserGroupIdentifier

Type: object

Title: ApplicationUserGroupIdentifier

Show Source

• applicationUserGroupId: integer (int64)
  The unique identifier of a user group.
• groupName: string
  Minimum Length: 1

  Maximum Length: 255

  Name of a user group.
• scope: string
  Allowed Values: [ "PROJECT", "WORKSPACE" ]

  Type of a user group.
• scopeCode: string
  The unique identifier for a project/workspace set by the user who created the project/workspace.
• scopeId: integer (int64)
  The unique identifier of a project/workspace.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApplicationUserGroupIdentifier",
    "type":"object",
    "properties":{
        "scopeId":{
            "type":"integer",
            "description":"The unique identifier of a project/workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "type":"string",
            "description":"Type of a user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT",
                "WORKSPACE"
            ]
        },
        "applicationUserGroupId":{
            "type":"integer",
            "description":"The unique identifier of a user group.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "groupName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"Name of a user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeCode":{
            "type":"string",
            "description":"The unique identifier for a project/workspace set by the user who created the project/workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CalendarIdentifier

Type: object

Title: CalendarIdentifier

Show Source

• calendarCode: string
  Maximum Length: 255

  The unique code for the calendar.
• calendarId: integer (int64)
  The unique identifier for the calendar.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CalendarIdentifier",
    "type":"object",
    "properties":{
        "calendarId":{
            "type":"integer",
            "description":"The unique identifier for the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "calendarCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique code for the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CodeTypeIdentifier

Type: object

Title: CodeTypeIdentifier

Show Source

• codeTypeCode: string
  Displays the code or ID of the Code Type.
• codeTypeId: integer (int64)
  The system-generated identifier of a code type.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CodeTypeIdentifier",
    "type":"object",
    "properties":{
        "codeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "type":"string",
            "description":"Displays the code or ID of the Code Type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CodeValueIdentifier

Type: object

Title: CodeValueIdentifier

Show Source

• codeTypeCode: string
  Displays the code or ID of the Code Type.
• codeTypeId: integer (int64)
  The system-generated identifier of a code type.
• codeValueCode: string
  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• parentCVCodes: array parentCVCodes
  List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"CodeValueIdentifier",
    "type":"object",
    "properties":{
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentCVCodes":{
            "type":"array",
            "description":"List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "type":"string",
            "description":"Displays the code or ID of the Code Type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CostCategoryIdentifier

Type: object

Title: CostCategoryIdentifier

Show Source

• abbreviation: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviation for the cost category name.
• costCategoryId: integer (int64)
  The system-generated identifier of a cost category.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the cost category.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CostCategoryIdentifier",
    "type":"object",
    "properties":{
        "costCategoryId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "abbreviation":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string",
            "description":"The abbreviation for the cost category name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CurveIdentifier

Type: object

Title: CurveIdentifier

Show Source

• curveId: integer (int64)
  The unique identifier of a curve.
• curveName: string
  Maximum Length: 255

  The name of the curve profile.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CurveIdentifier",
    "type":"object",
    "properties":{
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "curveName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the curve profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : DocumentFolderStructureTemplateIdentifier

Type: object

Title: DocumentFolderStructureTemplateIdentifier

Show Source

• documentFolderStructureTemplateId: integer (int64)
  The system-generated identifier of a document folder structure template.
• templateName: string
  Maximum Length: 255

  The name of the document template.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"DocumentFolderStructureTemplateIdentifier",
    "type":"object",
    "properties":{
        "documentFolderStructureTemplateId":{
            "type":"integer",
            "description":"The system-generated identifier of a document folder structure template.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "templateName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the document template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : IdeaIdentifier

Type: object

Title: IdeaIdentifier

Show Source

• ideaId: integer (int64)
  The system-generated identifier of an idea.
• ideaName: string
  The name of the Idea.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"IdeaIdentifier",
    "type":"object",
    "properties":{
        "ideaName":{
            "type":"string",
            "description":"The name of the Idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ideaId":{
            "type":"integer",
            "description":"The system-generated identifier of an idea.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : OfficeIdentifier

Type: object

Title: OfficeIdentifier

Show Source

• companyId: integer (int64)
  The system-generated identifier of a company.
• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the company.
• countryCode: string
  Maximum Length: 3

  The country for a location.
• officeId: integer (int64)
  The unique identifier of an office.
• officeName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the office.
• postalCode: string
  Maximum Length: 20

  The postal code, post code, or zip code of a location.

{
    "title":"OfficeIdentifier",
    "type":"object",
    "properties":{
        "officeId":{
            "type":"integer",
            "description":"The unique identifier of an office.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "officeName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the office.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The system-generated identifier of a company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "countryCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The country for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectCompanyIdentifier

Type: object

Title: ProjectCompanyIdentifier

Show Source

• companyId: integer (int64)
  The system-generated identifier of a company.
• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the company.
• postalCode: string
  Maximum Length: 20

  The postal code, post code, or zip code of a location.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectCompanyId: integer (int64)
  The system-generated unique identifier of the project company.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectCompanyIdentifier",
    "type":"object",
    "properties":{
        "projectCompanyId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the project company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The system-generated identifier of a company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ResourceDemandIdentifier

Type: object

Title: ResourceDemandIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceDemandId: integer (int64)
  The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ResourceDemandIdentifier",
    "type":"object",
    "properties":{
        "resourceDemandId":{
            "type":"integer",
            "description":"The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectBudgetChangeIdentifier

Type: object

Title: ProjectBudgetChangeIdentifier

Show Source

• budgetChangeCode: string
  Maximum Length: 60

  The unique identifier of the project budget change request.
• budgetChangeId: integer (int64)
  The system-generated identifier of a budget change.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectBudgetChangeIdentifier",
    "type":"object",
    "properties":{
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetChangeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the project budget change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectBudgetTransferIdentifier

Type: object

Title: ProjectBudgetTransferIdentifier

Show Source

• budgetTransferCode: string
  Maximum Length: 60

  The unique identifier of the project budget transfer request.
• budgetTransferId: integer (int64)
  The system-generated identifier of a budget transfer.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectBudgetTransferIdentifier",
    "type":"object",
    "properties":{
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the project budget transfer request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectResourceWorkRateIdentifier

Type: object

Title: ProjectResourceWorkRateIdentifier

Show Source

• effectiveStartDate: string (date-time)
  Date that the corresponding units/time period and rates go into effect for the resource or role.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectResourceId: integer (int64)
  The unique identifier of a project resource.
• projectResourceWorkRateId: integer (int64)
  The unique identifier of a project work rate.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  The code of a resource of a project resource.
• resourceId: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectResourceWorkRateIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "type":"string",
            "description":"The code of a resource of a project resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "effectiveStartDate":{
            "type":"string",
            "description":"Date that the corresponding units/time period and rates go into effect for the resource or role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectResourceWorkRateId":{
            "type":"integer",
            "description":"The unique identifier of a project work rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectResourceId":{
            "type":"integer",
            "description":"The unique identifier of a project resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectActualsLineItemIdentifier

Type: object

Title: ProjectActualsLineItemIdentifier

Show Source

• projectActualsCode: string
  The user-specified identifier of a project actual.
• projectActualsId: integer (int64)
  The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.
• projectActualsLineItemCode: string
  Maximum Length: 60

  The user-specified unique identifier for an actual line item.
• projectActualsLineItemId: integer (int64)
  The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectActualsLineItemIdentifier",
    "type":"object",
    "properties":{
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsLineItemId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsLineItemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier for an actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsCode":{
            "type":"string",
            "description":"The user-specified identifier of a project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectActualsIdentifier

Type: object

Title: ProjectActualsIdentifier

Show Source

• projectActualsCode: string
  The user-specified identifier of a project actual.
• projectActualsId: integer (int64)
  The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectActualsIdentifier",
    "type":"object",
    "properties":{
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsCode":{
            "type":"string",
            "description":"The user-specified identifier of a project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectBudgetItemIdentifier

Type: object

Title: ProjectBudgetItemIdentifier

Show Source

• budgetItemCode: string
  Maximum Length: 60

  The unique identifier of the project budget item.
• budgetItemId: integer (int64)
  The system-generated identifier of a budget item.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectBudgetItemIdentifier",
    "type":"object",
    "properties":{
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the project budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramIdentifier

Type: object

Title: ProgramIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramIdentifier",
    "type":"object",
    "properties":{
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : StrategyIdentifier

Type: object

Title: StrategyIdentifier

Show Source

• strategyId: integer (int64)
  The system-generated identifier of the strategy.
• strategyName: string
  The name of a strategy.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"StrategyIdentifier",
    "type":"object",
    "properties":{
        "strategyId":{
            "type":"integer",
            "description":"The system-generated identifier of the strategy.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "strategyName":{
            "type":"string",
            "description":"The name of a strategy.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : StrategyTypeIdentifier

Type: object

Title: StrategyTypeIdentifier

Show Source

• levelName: string
  The name of a strategy.
• strategyTypeId: integer (int64)
  The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"StrategyTypeIdentifier",
    "type":"object",
    "properties":{
        "levelName":{
            "type":"string",
            "description":"The name of a strategy.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategyTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RuleOfCreditIdentifier

Type: object

Title: RuleOfCreditIdentifier

Show Source

• rocId: integer (int64)
  Unique identifier of the rule of credit.
• rocName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the rule of credit.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"RuleOfCreditIdentifier",
    "type":"object",
    "properties":{
        "rocId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rocName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ResourceRoleAssignmentIdentifier

Type: object

Title: ResourceRoleAssignmentIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• resourceCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• resourceRoleAssignmentId: integer (int64)
  The system-generated identifier of the resource role assignment.
• roleCode: string
  The user-specified identifier of the role.
• roleId: integer (int64)
  The unique identifier for the role.The role object can also be identified by its unique criteria.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ResourceRoleAssignmentIdentifier",
    "type":"object",
    "properties":{
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "roleId":{
            "type":"integer",
            "description":"The unique identifier for the role.The role object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "roleCode":{
            "type":"string",
            "description":"The user-specified identifier of the role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceRoleAssignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of the resource role assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : BudgetPlanningScenarioIdentifier

Type: object

Title: BudgetPlanningScenarioIdentifier

Show Source

• planPeriod: integer (int32)
  The period during which budget is allocated to projects within the plan.
  This value determines the year in which budget planning timescales start.
  You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
  After the planning period for a budget plan has been set it cannot be changed.
• portfolioId: integer (int64)
  The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• portfolioName: string
  Maximum Length: 255

  The name of the portfolio.
• scenarioId: integer (int64)
  The system-generated identifier of the Budget Plan Scenario.
• scenarioName: string
  Maximum Length: 255

  The name of Budget Plan Scenario.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"BudgetPlanningScenarioIdentifier",
    "type":"object",
    "properties":{
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Budget Plan Scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scenarioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of Budget Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "planPeriod":{
            "type":"integer",
            "description":"The period during which budget is allocated to projects within the plan. <br />This value determines the year in which budget planning timescales start. <br />You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021. <br />After the planning period for a budget plan has been set it cannot be changed.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ScopeAssignmentPlannedTimePhasedDataIdentifier

Type: object

Title: ScopeAssignmentPlannedTimePhasedDataIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentPlannedTimePhasedDataId: integer (int64)
  The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignCode: string
  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ScopeAssignmentPlannedTimePhasedDataIdentifier",
    "type":"object",
    "properties":{
        "scopeAssignmentPlannedTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramBudgetTransferIdentifier

Type: object

Title: ProgramBudgetTransferIdentifier

Show Source

• programBudgetId: integer (int64)
  The system-generated identifier of a program budget.
• programBudgetTransferCode: string
  Maximum Length: 60

  The unique identifier of the program budget transfer request.
• programBudgetTransferId: integer (int64)
  The system-generated identifier of a program budget transfer.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramBudgetTransferIdentifier",
    "type":"object",
    "properties":{
        "programBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget transfer. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransferCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the program budget transfer request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramBudgetChangeIdentifier

Type: object

Title: ProgramBudgetChangeIdentifier

Show Source

• programBudgetChangeCode: string
  Maximum Length: 60

  The unique identifier of the program budget change request.
• programBudgetChangeId: integer (int64)
  The system-generated identifier of a program budget change.
• programBudgetId: integer (int64)
  The system-generated identifier of a program budget.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramBudgetChangeIdentifier",
    "type":"object",
    "properties":{
        "programBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetChangeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the program budget change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ActivityIdentifier

Type: object

Title: ActivityIdentifier

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier for the activity.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ActivityIdentifier",
    "type":"object",
    "properties":{
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : AssignmentIdentifier

Type: object

Title: AssignmentIdentifier

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier for the activity.The activity object can also be identified by its unique criteria.
• assignmentCode: string
  Maximum Length: 60

  A unique identifier for the assignment.
• assignmentId: integer (int64)
  The system-generated identifier of an assignment.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class of the resource of an assignment.
• resourceCode: string
  The user-specified identifier of a resource.
• resourceId: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"AssignmentIdentifier",
    "type":"object",
    "properties":{
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of an assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentCode":{
            "maxLength":"60",
            "type":"string",
            "description":"A unique identifier for the assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "type":"string",
            "description":"The user-specified identifier of a resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class of the resource of an assignment. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RelationshipIdentifier

Type: object

Title: RelationshipIdentifier

Show Source

• predActivityCode: string
  The code of the predecessor activity.
• predActivityId: integer (int64)
  The unique identifier of the predecessor of an activity.
• predProjectCode: string
  The code of the project of the predecessor of an activity.
• predWorkspaceCode: string
  The code of the workspace of the predecessor of an activity.
• relationshipId: integer (int64)
  The system-generated identifier of an activity relationship.
• succActivityCode: string
  The code of the successor activity.
• succActivityId: integer (int64)
  The unique identifier of the successor of an activity.
• succProjectCode: string
  The code of the project of the successor of an activity.
• succWorkspaceCode: string
  The code of the workspace of the successor of an activity.

{
    "title":"RelationshipIdentifier",
    "type":"object",
    "properties":{
        "relationshipId":{
            "type":"integer",
            "description":"The system-generated identifier of an activity relationship.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "predActivityId":{
            "type":"integer",
            "description":"The unique identifier of the predecessor of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "succActivityId":{
            "type":"integer",
            "description":"The unique identifier of the successor of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "predActivityCode":{
            "type":"string",
            "description":"The code of the predecessor activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "succActivityCode":{
            "type":"string",
            "description":"The code of the successor activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "predProjectCode":{
            "type":"string",
            "description":"The code of the project of the predecessor of an activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "succProjectCode":{
            "type":"string",
            "description":"The code of the project of the successor of an activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "succWorkspaceCode":{
            "type":"string",
            "description":"The code of the workspace of the successor of an activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "predWorkspaceCode":{
            "type":"string",
            "description":"The code of the workspace of the predecessor of an activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : FundActualIdentifier

Type: object

Title: FundActualIdentifier

Show Source

• fundActualId: integer (int64)
  The system-generated identifier of a fund actual.
• fundCode: string
  The user-specified unique identifier of a fund.
• fundId: integer (int64)
  The system-generated identifier of a fund.
• projectActualsCode: string
  Maximum Length: 60

  The unique identifier for an actual.
• projectActualsId: integer (int64)
  The system-generated identifier of a project actual.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"FundActualIdentifier",
    "type":"object",
    "properties":{
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system-generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundCode":{
            "type":"string",
            "description":"The user-specified unique identifier of a fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The system-generated identifier of a project actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for an actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundActualId":{
            "type":"integer",
            "description":"The system-generated identifier of a fund actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramBudgetItemIdentifier

Type: object

Title: ProgramBudgetItemIdentifier

Show Source

• programBudgetId: integer (int64)
  The ID of the program budget.
• programBudgetItemCode: string
  Maximum Length: 60

  The unique identifier of the program budget item.
• programBudgetItemId: integer (int64)
  The system-generated identifier for a budget.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramBudgetItemIdentifier",
    "type":"object",
    "properties":{
        "programBudgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for a budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetId":{
            "type":"integer",
            "description":"The ID of the program budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetItemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the program budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : parentCVCodes

Type: array

List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

400 Response

Invalid Input.

Back to Top