View all Programs by Project
get
/api/restapi/program/project/{projectId}
This endpoint returns programs that meet the following requirements:
- The object belongs to a project with an ID value that matches the value of the {projectId} path parameter.
Request
Path Parameters
-
projectId(required): integer(int64)
The system-generated identifier of a project.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityProgram>
Type:
array
Title:
Show Source
List<ApiEntityProgram>
-
Array of:
object ApiEntityProgram
Title:
ApiEntityProgram
Nested Schema : ApiEntityProgram
Type:
object
Title:
Show Source
ApiEntityProgram
-
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.
-
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)
The date the program was added.
-
createUser: string
Maximum Length:
255
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)
The unique identifier for the program evaluation.
-
evaluationScore: number
(double)
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)
The most recent evaluation date for the program.
-
link: string
(url)
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. -
programId: integer
(int64)
The unique identifier for the program.
-
programName: string
Minimum Length:
1
Maximum Length:255
The name of 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)
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)
Date when the record was last updated.
-
updateUser: string
Maximum Length:
255
The user who last modified the program -
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier of a workspace.
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 ApiEntityCodeValueProgram
Title:
ApiEntityCodeValueProgram
Nested Schema : configuredFields
Type:
array
The list of configured fields for a program.
Show Source
-
Array of:
object ApiEntityProgramConfiguredFieldValue
Title:
ApiEntityProgramConfiguredFieldValue
Nested Schema : linkedObjects
Type:
array
The list of projects linked to the program.
Show Source
-
Array of:
object ApiEntityProgramLinkedObject
Title:
ApiEntityProgramLinkedObject
Nested Schema : ApiEntityCodeValueProgram
Type:
object
Title:
Show Source
ApiEntityCodeValueProgram
-
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: integer
(int64)
The ID for the code type.
-
codeValueCode: 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: 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)
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)
Date when the record was last updated.
Nested Schema : ApiEntityProgramConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityProgramConfiguredFieldValue
-
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
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)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
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
Maximum Length:
4000
Provides the error message for why the formula calculation resulted in an error. -
hasException: boolean
Determines if formula calculation hit an error calculating a value for this field.
-
link: string
(url)
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)
Date when the record was last updated.
Nested Schema : ApiEntityProgramLinkedObject
Type:
object
Title:
Show Source
ApiEntityProgramLinkedObject
-
action: string
Allowed Values:
[ "DELETE" ]
-
link: string
(url)
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)
Date when the record was last updated.
204 Response
Successful operation with no content.
404 Response
The requested program does not exist, or you do not have access to it.