Update a program
patch
/fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}
Request
Path Parameters
-
projectProgramsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Project Programs resource and used to uniquely identify an instance of Project Programs. The client should not generate the hash key value. Instead, the client should query on the Project Programs collection resource in order to navigate to a specific instance of Project Programs to get the hash key.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssessmentCode: string
Title:
Assessment Code
Maximum Length:30
The code that represents the program owner's ongoing assessment for the likelihood that the program will meet the program objectives. Examples for assessments are On track and At risk. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_ASSESSMENT. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
AssessmentMeaning: string
Title:
Assessment Code
The program owner's ongoing assessment for the likelihood that the program will meet the program objectives. Examples for assessments are On track and At risk. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_ASSESSMENT. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
FinishDate: string
(date)
Title:
Finish Date
The date when the program is finished. The value is for informational purposes only. -
LineOfBusinessCode: string
Title:
Line of Business Code
Maximum Length:30
The code that represents the line of business name for the set of products and services that are managed by the program. Examples for line of business names are Product development and All lines of business. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_BUSINESS. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
LineOfBusinessMeaning: string
The line of business name for the set of products and services that are managed by the program. Examples for line of business names are Product development and All lines of business. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_BUSINESS. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
-
OwningOrganizationId: integer
(int64)
Title:
Owning Organization ID
The unique identifier of the owning organization. -
OwningOrganizationName: string
The name of the owning organization. The value is for informational purposes only. Review and update organizations classified as owning organizations using the Setup and Maintenance work area and the task Manage Project Organization Classifications.
-
ParentProgramId: integer
(int64)
Title:
Parent Program ID
The unique identifier of the parent program. A program without a parent is the root node in the hierarchy structure. -
ParentProgramNumber: string
The unique number of the parent program. A program without a parent is the root node in the hierarchy structure.
-
PriorityCode: string
Title:
Priority Code
Maximum Length:30
The code that represents the priority for the program. Examples for priority are High, Medium, and Low. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_PRIORITY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
PriorityMeaning: string
The priority for the program. Examples for priority are High, Medium, and Low. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_PRIORITY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
-
ProgramAvatars: array
Program Avatars
Title:
Program Avatars
The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time. -
ProgramBudget: number
The budgeted amount allotted to the program.
-
ProgramBudgetCurrency: string
Maximum Length:
15
The currency of the budgeted amount allotted to the program. -
ProgramDescription: string
Maximum Length:
2000
The description of the program. -
ProgramName: string
Maximum Length:
240
The unique name of the program. A value is required to create a program. -
ProgramNotes: array
Program Notes
Title:
Program Notes
The Program Notes resource is used to manage notes for programs. -
ProgramObjective: string
Maximum Length:
400
The objective of the program. -
ProgramProjects: array
Project Assignments
Title:
Project Assignments
The Project Assignments resource is used to manage the assignments of projects to a program. -
ProgramStakeholders: array
Stakeholders
Title:
Stakeholders
The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program. -
ProgramStatusName: string
The status of the program. Examples for status are Draft and Active. A value is required to create a program. Review and update the program status list of values using the Setup and Maintenance work area and the Manage Project Statuses task.
-
ProgramSystemStatusCode: string
Maximum Length:
30
Default Value:ORA_PROGRAM_ACTIVE
The code that represents the system status defined for the program status. Values are DRAFT, SUBMITTED, ACTIVE, PENDING_CLOSE, and CLOSED. Review and update the program status list of values using the Setup and Maintenance work area and the Manage Project Statuses task. -
PublicFlag: boolean
Title:
Public access
Maximum Length:1
Default Value:false
Indicates whether the program hierarchy can be viewed by all. If true, then programs in the hierarchy can be viewed by all. If false, then only the persons assigned as stakeholders directly or inherited from a parent or grandparent program can view their programs. The value is defined for the root node of the hierarchy. The default value is false. -
RegionCode: string
Title:
Region Code
Maximum Length:30
The code that represents the geographic or divisional region that's covered by the program. Examples for region names are North America and All regions. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_REGION. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
RegionMeaning: string
The geographic or divisional region that's covered by the program. Examples for region names are North America and All regions. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_REGION. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
-
StartDate: string
(date)
Title:
Start Date
The date on which the program starts. The value is for informational purposes only. -
StrategyCode: string
Title:
Strategy Code
Maximum Length:30
The code that represents the strategic plan of actions and policies that are targeted by the program. An example for strategy is Innovation. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_STRATEGY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
StrategyMeaning: string
The strategic plan of actions and policies that are targeted by the program. An example strategy is Innovation. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_STRATEGY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
-
TreeStructureId: integer
(int64)
Title:
Tree Structure ID
The unique identifier of the program hierarchy structure.
Nested Schema : Program Avatars
Type:
array
Title:
Program Avatars
The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time.
Show Source
Nested Schema : Program Notes
Type:
array
Title:
Program Notes
The Program Notes resource is used to manage notes for programs.
Show Source
Nested Schema : Project Assignments
Type:
array
Title:
Project Assignments
The Project Assignments resource is used to manage the assignments of projects to a program.
Show Source
Nested Schema : Stakeholders
Type:
array
Title:
Stakeholders
The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program.
Show Source
Nested Schema : projectPrograms-ProgramAvatars-item-patch-request
Type:
Show Source
object
-
Image: string
(byte)
Title:
Image
The base 64 encoded image. -
ImageName: string
Title:
Image Name
Maximum Length:240
The name of the image.
Nested Schema : projectPrograms-ProgramNotes-item-patch-request
Type:
Show Source
object
-
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Unique identifier of the user who created the note. -
NoteTxt: string
(byte)
Title:
Note Text
The text for the program note.
Nested Schema : projectPrograms-ProgramProjects-item-patch-request
Type:
Show Source
object
-
ProgramProjectNotes: array
Project Assignment Notes
Title:
Project Assignment Notes
The Project Assignment Notes resource is used to manage notes for the project assignments to a program. -
RelationshipId: integer
(int64)
Title:
Project Association ID
The unique identifier of the project assignment to a program.
Nested Schema : Project Assignment Notes
Type:
array
Title:
Project Assignment Notes
The Project Assignment Notes resource is used to manage notes for the project assignments to a program.
Show Source
Nested Schema : projectPrograms-ProgramProjects-ProgramProjectNotes-item-patch-request
Type:
Show Source
object
-
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Unique identifier of the user who created the note. -
NoteTxt: string
(byte)
Title:
Note Text
The text for the project assignment note.
Nested Schema : projectPrograms-ProgramStakeholders-item-patch-request
Type:
Show Source
object
-
AccessType: string
The access type for the assignee. The assignee with owner access can edit and delete the program. An assignee with contributor access can edit the program. An assignee with viewer access can view the program and receive stakeholder communications. The person who creates the program is the default owner. Only one direct assignment can have owner access at a given time. Valid values are Owner, Contributor, and Viewer. The default value is Viewer.
-
AccessTypeCode: string
Title:
Access Type Code
Maximum Length:30
The code that represents the access type for the assignee. The assignee with owner access can edit and delete the program. An assignee with contributor access can edit the program. An assignee with viewer access can view the program and receive stakeholder communications. The person who creates the program is the default owner. Only one direct assignment can have owner access at a given time. Valid values are OWNER, EDIT, and VIEW. The default value is VIEW. -
StakeholderAssociationId: integer
(int64)
Title:
Stakeholder Assignment ID
The unique identifier of the stakeholder assignment to a program.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectPrograms-item-response
Type:
Show Source
object
-
AssessmentCode: string
Title:
Assessment Code
Maximum Length:30
The code that represents the program owner's ongoing assessment for the likelihood that the program will meet the program objectives. Examples for assessments are On track and At risk. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_ASSESSMENT. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
AssessmentMeaning: string
Title:
Assessment Code
The program owner's ongoing assessment for the likelihood that the program will meet the program objectives. Examples for assessments are On track and At risk. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_ASSESSMENT. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
FinishDate: string
(date)
Title:
Finish Date
The date when the program is finished. The value is for informational purposes only. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LineOfBusinessCode: string
Title:
Line of Business Code
Maximum Length:30
The code that represents the line of business name for the set of products and services that are managed by the program. Examples for line of business names are Product development and All lines of business. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_BUSINESS. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
LineOfBusinessMeaning: string
The line of business name for the set of products and services that are managed by the program. Examples for line of business names are Product development and All lines of business. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_BUSINESS. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwningOrganizationId: integer
(int64)
Title:
Owning Organization ID
The unique identifier of the owning organization. -
OwningOrganizationName: string
The name of the owning organization. The value is for informational purposes only. Review and update organizations classified as owning organizations using the Setup and Maintenance work area and the task Manage Project Organization Classifications.
-
ParentProgramId: integer
(int64)
Title:
Parent Program ID
The unique identifier of the parent program. A program without a parent is the root node in the hierarchy structure. -
ParentProgramNumber: string
The unique number of the parent program. A program without a parent is the root node in the hierarchy structure.
-
PriorityCode: string
Title:
Priority Code
Maximum Length:30
The code that represents the priority for the program. Examples for priority are High, Medium, and Low. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_PRIORITY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
PriorityMeaning: string
The priority for the program. Examples for priority are High, Medium, and Low. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_PRIORITY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
-
ProgramAvatars: array
Program Avatars
Title:
Program Avatars
The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time. -
ProgramBudget: number
The budgeted amount allotted to the program.
-
ProgramBudgetCurrency: string
Maximum Length:
15
The currency of the budgeted amount allotted to the program. -
ProgramDescription: string
Maximum Length:
2000
The description of the program. -
ProgramName: string
Maximum Length:
240
The unique name of the program. A value is required to create a program. -
ProgramNotes: array
Program Notes
Title:
Program Notes
The Program Notes resource is used to manage notes for programs. -
ProgramNumber: string
Title:
Program Number
Maximum Length:25
The unique number of the program. The default value is the unique identifier of the program. -
ProgramObjective: string
Maximum Length:
400
The objective of the program. -
ProgramProjects: array
Project Assignments
Title:
Project Assignments
The Project Assignments resource is used to manage the assignments of projects to a program. -
ProgramStakeholders: array
Stakeholders
Title:
Stakeholders
The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program. -
ProgramStatusName: string
The status of the program. Examples for status are Draft and Active. A value is required to create a program. Review and update the program status list of values using the Setup and Maintenance work area and the Manage Project Statuses task.
-
ProgramSystemStatusCode: string
Maximum Length:
30
Default Value:ORA_PROGRAM_ACTIVE
The code that represents the system status defined for the program status. Values are DRAFT, SUBMITTED, ACTIVE, PENDING_CLOSE, and CLOSED. Review and update the program status list of values using the Setup and Maintenance work area and the Manage Project Statuses task. -
ProjectProgramId: integer
(int64)
Title:
Program ID
Read Only:true
The unique identifier of the program. -
PublicFlag: boolean
Title:
Public access
Maximum Length:1
Default Value:false
Indicates whether the program hierarchy can be viewed by all. If true, then programs in the hierarchy can be viewed by all. If false, then only the persons assigned as stakeholders directly or inherited from a parent or grandparent program can view their programs. The value is defined for the root node of the hierarchy. The default value is false. -
RegionCode: string
Title:
Region Code
Maximum Length:30
The code that represents the geographic or divisional region that's covered by the program. Examples for region names are North America and All regions. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_REGION. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
RegionMeaning: string
The geographic or divisional region that's covered by the program. Examples for region names are North America and All regions. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_REGION. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
-
StartDate: string
(date)
Title:
Start Date
The date on which the program starts. The value is for informational purposes only. -
StrategyCode: string
Title:
Strategy Code
Maximum Length:30
The code that represents the strategic plan of actions and policies that are targeted by the program. An example for strategy is Innovation. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_STRATEGY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task. -
StrategyMeaning: string
The strategic plan of actions and policies that are targeted by the program. An example strategy is Innovation. A list of accepted values is defined in the lookup type ORA_PROJECT_PROGRAM_STRATEGY. Review and update the list of values using the Setup and Maintenance work area and the Manage Standard Lookups task.
-
TreeStructureId: integer
(int64)
Title:
Tree Structure ID
The unique identifier of the program hierarchy structure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Program Avatars
Type:
array
Title:
Program Avatars
The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time.
Show Source
Nested Schema : Program Notes
Type:
array
Title:
Program Notes
The Program Notes resource is used to manage notes for programs.
Show Source
Nested Schema : Project Assignments
Type:
array
Title:
Project Assignments
The Project Assignments resource is used to manage the assignments of projects to a program.
Show Source
Nested Schema : Stakeholders
Type:
array
Title:
Stakeholders
The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : projectPrograms-ProgramAvatars-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
Image: string
(byte)
Title:
Image
The base 64 encoded image. -
ImageId: integer
(int64)
Title:
Image ID
Read Only:true
The unique identifier of the image for a program. -
ImageName: string
Title:
Image Name
Maximum Length:240
The name of the image. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPrograms-ProgramNotes-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Unique identifier of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of the program note. -
NoteNumber: string
Title:
Note Number
Maximum Length:30
The unique number of the program note. The default value is a system-generated number. -
NoteTxt: string
(byte)
Title:
Note Text
The text for the program note. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the user who created the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPrograms-ProgramProjects-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProgramProjectNotes: array
Project Assignment Notes
Title:
Project Assignment Notes
The Project Assignment Notes resource is used to manage notes for the project assignments to a program. -
ProjectId: integer
(int64)
Title:
Project ID
The unique identifier of the project. -
ProjectNumber: string
The unique number of the project.
-
RelationshipId: integer
(int64)
Title:
Project Association ID
The unique identifier of the project assignment to a program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Project Assignment Notes
Type:
array
Title:
Project Assignment Notes
The Project Assignment Notes resource is used to manage notes for the project assignments to a program.
Show Source
Nested Schema : projectPrograms-ProgramProjects-ProgramProjectNotes-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Unique identifier of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of the project assignment note. -
NoteNumber: string
Title:
Note Number
Maximum Length:30
The unique number of the project assignment note. The default value is a system-generated number. -
NoteTxt: string
(byte)
Title:
Note Text
The text for the project assignment note. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the user who created the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectPrograms-ProgramStakeholders-item-response
Type:
Show Source
object
-
AccessType: string
The access type for the assignee. The assignee with owner access can edit and delete the program. An assignee with contributor access can edit the program. An assignee with viewer access can view the program and receive stakeholder communications. The person who creates the program is the default owner. Only one direct assignment can have owner access at a given time. Valid values are Owner, Contributor, and Viewer. The default value is Viewer.
-
AccessTypeCode: string
Title:
Access Type Code
Maximum Length:30
The code that represents the access type for the assignee. The assignee with owner access can edit and delete the program. An assignee with contributor access can edit the program. An assignee with viewer access can view the program and receive stakeholder communications. The person who creates the program is the default owner. Only one direct assignment can have owner access at a given time. Valid values are OWNER, EDIT, and VIEW. The default value is VIEW. -
AssignmentCategory: string
Read Only:
true
The assignment category for the assignee as directly assigned or inherited from the program's parent or grandparent in the program hierarchy. Values are Inherited and Direct. -
AssignmentCategoryCode: string
Title:
Assignment Category Code
Read Only:true
Maximum Length:30
Default Value:ORA_PJS_DIRECT
The code that represents the assignment category for the assignee as directly assigned or inherited from the program's parent or grandparent in the program hierarchy. Values are INHERITED and DIRECT. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
Image: string
(byte)
Title:
Image
Read Only:true
The avatar image for a person. -
ImageId: integer
(int64)
Read Only:
true
The unique identifier of the avatar image for a person. -
ImageName: string
Read Only:
true
Maximum Length:240
The name of the avatar image for a person. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonEmail: string
Title:
Email
Maximum Length:240
The email of the person who's assigned to the program as a stakeholder. -
PersonId: integer
(int64)
Title:
Person ID
The unique identifier of the person who's assigned to the program as a stakeholder. -
PersonName: string
Title:
Name
Maximum Length:240
The name of the person who's assigned to the program as a stakeholder. -
StakeholderAssociationId: integer
(int64)
Title:
Stakeholder Assignment ID
The unique identifier of the stakeholder assignment to a program.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ProgramAvatars
-
Operation: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatarsParameters:
- projectProgramsUniqID:
$request.path.projectProgramsUniqID
The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time. - projectProgramsUniqID:
- ProgramNotes
-
Operation: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotesParameters:
- projectProgramsUniqID:
$request.path.projectProgramsUniqID
The Program Notes resource is used to manage notes for programs. - projectProgramsUniqID:
- ProgramProjects
-
Operation: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjectsParameters:
- projectProgramsUniqID:
$request.path.projectProgramsUniqID
The Project Assignments resource is used to manage the assignments of projects to a program. - projectProgramsUniqID:
- ProgramStakeholders
-
Operation: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramStakeholdersParameters:
- projectProgramsUniqID:
$request.path.projectProgramsUniqID
The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program. - projectProgramsUniqID:
Examples
The following example shows how to update a program by submitting a PATCH request on the REST resource using cURL.
curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPrograms/<projectProgramId>"
Request Body Example
The following shows an example of the request body in JSON format.
{ "ProgramStatusName":"Closed" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "AssessmentCode": null, "AssessmentMeaning": null, "CreatedBy": "Clayton.Smith", "CreationDate": "2022-02-28T15:19:19.001+00:00", "FinishDate": null, "LastUpdateDate": "2022-02-28T15:22:46+00:00", "LastUpdatedBy": "Clayton.Smith", "LineOfBusinessCode": null, "LineOfBusinessMeaning": null, "ParentProgramId": null, "ParentProgramNumber": null, "PriorityCode": null, "PriorityMeaning": null, "ProgramDescription": null, "ProjectProgramId": 300100549355134, "ProgramName": "Innovation Program", "ProgramNumber": "100100100", "ProgramObjective": null, "ProgramStatusName": "Closed", "ProgramSystemStatusCode": "ORA_PROGRAM_CLOSED", "PublicFlag": false, "RegionCode": null, "RegionMeaning": null, "StartDate": null, "StrategyCode": null, "StrategyMeaning": null, "TreeStructureId": 300100549355134, "OwningOrganizationName": null, "OwningOrganizationId": null, "ProgramBudget": null, "ProgramBudgetCurrency": null, "links": [ { "rel": "self", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355134", "name": "projectPrograms", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355134", "name": "projectPrograms", "kind": "item" }, { "rel": "child", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355134/child/ProgramAvatars", "name": "ProgramAvatars", "kind": "collection" }, { "rel": "child", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355134/child/ProgramNotes", "name": "ProgramNotes", "kind": "collection" }, { "rel": "child", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355134/child/ProgramProjects", "name": "ProgramProjects", "kind": "collection" }, { "rel": "child", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355134/child/ProgramStakeholders", "name": "ProgramStakeholders", "kind": "collection" } ] }