Jump to

• Request
• Response
• Examples

Get a program

get

/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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : projectPrograms-item-response

Type: object

Show Source

• 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.
• ProgramDFF: array ProgramDFF
• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramNotes":{
            "title":"Program Notes",
            "type":"array",
            "description":"The Program Notes resource is used to manage notes for programs.",
            "items":{
                "$ref":"#/components/schemas/projectPrograms-ProgramNotes-item-response"
            }
        },
        "RegionCode":{
            "title":"Region Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PriorityCode":{
            "title":"Priority Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RegionMeaning":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RegionCode"
                ]
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the program starts. The value is for informational purposes only.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ParentProgramNumber":{
            "type":"string",
            "description":"The unique number of the parent program. A program without a parent is the root node in the hierarchy structure.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LineOfBusinessMeaning":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LineOfBusinessCode"
                ]
            },
            "x-queryable":true
        },
        "ProgramDescription":{
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the program.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramNumber":{
            "title":"Program Number",
            "maxLength":"25",
            "type":"string",
            "description":"The unique number of the program. The default value is the unique identifier of the program.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicFlag":{
            "title":"Public access",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ProgramBudgetCurrency":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the budgeted amount allotted to the program.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentProgramId":{
            "title":"Parent Program ID",
            "type":"integer",
            "description":"The unique identifier of the parent program. A program without a parent is the root node in the hierarchy structure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ParentProgramNumber"
                ]
            },
            "x-queryable":true
        },
        "ProgramBudget":{
            "type":"number",
            "description":"The budgeted amount allotted to the program.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/projectPrograms-ProgramDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ProgramAvatars":{
            "title":"Program Avatars",
            "type":"array",
            "description":"The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time.",
            "items":{
                "$ref":"#/components/schemas/projectPrograms-ProgramAvatars-item-response"
            }
        },
        "StrategyCode":{
            "title":"Strategy Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramStatusName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProgramStatusCode"
                ]
            },
            "x-queryable":true
        },
        "StrategyMeaning":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "StrategyCode"
                ]
            },
            "x-queryable":true
        },
        "OwningOrganizationName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssessmentMeaning":{
            "title":"Assessment Code",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssessmentCode"
                ]
            },
            "x-queryable":true
        },
        "ProgramObjective":{
            "maxLength":"400",
            "type":"string",
            "description":"The objective of the program.",
            "nullable":true,
            "x-queryable":true
        },
        "TreeStructureId":{
            "title":"Tree Structure ID",
            "type":"integer",
            "description":"The unique identifier of the program hierarchy structure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FinishDate":{
            "title":"Finish Date",
            "type":"string",
            "description":"The date when the program is finished. The value is for informational purposes only.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "maxLength":"240",
            "type":"string",
            "description":"The unique name of the program. A value is required to create a program.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramSystemStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"ORA_PROGRAM_ACTIVE",
            "x-queryable":true
        },
        "OwningOrganizationId":{
            "title":"Owning Organization ID",
            "type":"integer",
            "description":"The unique identifier of the owning organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LineOfBusinessCode":{
            "title":"Line of Business Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentCode":{
            "title":"Assessment Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramStakeholders":{
            "title":"Stakeholders",
            "type":"array",
            "description":"The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program.",
            "items":{
                "$ref":"#/components/schemas/projectPrograms-ProgramStakeholders-item-response"
            }
        },
        "PriorityMeaning":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PriorityCode"
                ]
            },
            "x-queryable":true
        },
        "ProjectProgramId":{
            "title":"Program ID",
            "type":"integer",
            "description":"The unique identifier of the program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProgramProjects":{
            "title":"Project Assignments",
            "type":"array",
            "description":"The Project Assignments resource is used to manage the assignments of projects to a program.",
            "items":{
                "$ref":"#/components/schemas/projectPrograms-ProgramProjects-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object projectPrograms-ProgramAvatars-item-response

{
    "title":"Program Avatars",
    "type":"array",
    "description":"The Program Avatars resource is used to manage the avatar image for a program. A program can have only one avatar at a time.",
    "items":{
        "$ref":"#/components/schemas/projectPrograms-ProgramAvatars-item-response"
    }
}

Nested Schema : ProgramDFF

Type: array

Show Source

• Array of: object projectPrograms-ProgramDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/projectPrograms-ProgramDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Program Notes

Type: array

Title: Program Notes

The Program Notes resource is used to manage notes for programs.

Show Source

• Array of: object projectPrograms-ProgramNotes-item-response

{
    "title":"Program Notes",
    "type":"array",
    "description":"The Program Notes resource is used to manage notes for programs.",
    "items":{
        "$ref":"#/components/schemas/projectPrograms-ProgramNotes-item-response"
    }
}

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

• Array of: object projectPrograms-ProgramProjects-item-response

{
    "title":"Project Assignments",
    "type":"array",
    "description":"The Project Assignments resource is used to manage the assignments of projects to a program.",
    "items":{
        "$ref":"#/components/schemas/projectPrograms-ProgramProjects-item-response"
    }
}

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

• Array of: object projectPrograms-ProgramStakeholders-item-response

{
    "title":"Stakeholders",
    "type":"array",
    "description":"The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program.",
    "items":{
        "$ref":"#/components/schemas/projectPrograms-ProgramStakeholders-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : projectPrograms-ProgramAvatars-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ImageName":{
            "title":"Image Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the image.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ImageId":{
            "title":"Image ID",
            "type":"integer",
            "description":"The unique identifier of the image for a program.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Image":{
            "title":"Image",
            "type":"string",
            "description":"The base 64 encoded image.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : projectPrograms-ProgramDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectProgramId: integer (int64)
  Title: Program ID

  Read Only: true

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectProgramId":{
            "title":"Program ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : projectPrograms-ProgramNotes-item-response

Type: object

Show Source

• 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
  Read Only: true

  Maximum Length: 360

  Name of the user who created the note.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the program note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteNumber":{
            "title":"Note Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number of the program note. The default value is a system-generated number.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Unique identifier of the user who created the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the user who created the note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteTxt":{
            "title":"Note Text",
            "type":"string",
            "description":"The text for the program note.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : projectPrograms-ProgramProjects-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramProjectNotes":{
            "title":"Project Assignment Notes",
            "type":"array",
            "description":"The Project Assignment Notes resource is used to manage notes for the project assignments to a program.",
            "items":{
                "$ref":"#/components/schemas/projectPrograms-ProgramProjects-ProgramProjectNotes-item-response"
            }
        },
        "RelationshipId":{
            "title":"Project Association ID",
            "type":"integer",
            "description":"The unique identifier of the project assignment to a program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProjectNumber":{
            "type":"string",
            "description":"The unique number of the project.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"The unique identifier of the project.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object projectPrograms-ProgramProjects-ProgramProjectNotes-item-response

{
    "title":"Project Assignment Notes",
    "type":"array",
    "description":"The Project Assignment Notes resource is used to manage notes for the project assignments to a program.",
    "items":{
        "$ref":"#/components/schemas/projectPrograms-ProgramProjects-ProgramProjectNotes-item-response"
    }
}

Nested Schema : projectPrograms-ProgramProjects-ProgramProjectNotes-item-response

Type: object

Show Source

• 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
  Read Only: true

  Maximum Length: 360

  Name of the user who created the note.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the project assignment note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteNumber":{
            "title":"Note Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number of the project assignment note. The default value is a system-generated number.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Unique identifier of the user who created the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the user who created the note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteTxt":{
            "title":"Note Text",
            "type":"string",
            "description":"The text for the project assignment note.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : projectPrograms-ProgramStakeholders-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the person who's assigned to the program as a stakeholder.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentCategoryCode":{
            "title":"Assignment Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_PJS_DIRECT",
            "x-queryable":true
        },
        "Image":{
            "title":"Image",
            "type":"string",
            "description":"The avatar image for a person.",
            "format":"byte",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessTypeCode":{
            "title":"Access Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ImageName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of the avatar image for a person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the person who's assigned to the program as a stakeholder.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StakeholderAssociationId":{
            "title":"Stakeholder Assignment ID",
            "type":"integer",
            "description":"The unique identifier of the stakeholder assignment to a program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssignmentCategory":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AssignmentCategoryCode"
                ]
            },
            "x-queryable":true
        },
        "ImageId":{
            "type":"integer",
            "description":"The unique identifier of the avatar image for a person.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersonEmail":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"The email of the person who's assigned to the program as a stakeholder.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccessType":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ProgramAvatars

Operation: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramAvatars

Parameters:

• 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.

ProgramDFF

Operation: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramDFF

Parameters:

• projectProgramsUniqID: $request.path.projectProgramsUniqID

ProgramNotes

Operation: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes

Parameters:

• projectProgramsUniqID: $request.path.projectProgramsUniqID

The Program Notes resource is used to manage notes for programs.

ProgramProjects

Operation: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramProjects

Parameters:

• projectProgramsUniqID: $request.path.projectProgramsUniqID

The Project Assignments resource is used to manage the assignments of projects to a program.

ProgramStakeholders

Operation: /fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramStakeholders

Parameters:

• projectProgramsUniqID: $request.path.projectProgramsUniqID

The Stakeholders resource is used to manage the assignment of stakeholders and program administrators for a program.

Back to Top

Examples

The following example shows how to get a program by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user -X GET -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPrograms/<projectProgramId>"

Response Body Example

The following shows an example of the response body in JSON format.

{
    "AssessmentCode" : "ORA_PJS_ON_TRACK",
    "AssessmentMeaning" : "On Track",
    "CreatedBy" : "Monica.Suchet",
    "CreationDate" : "2022-03-01T21:09:06.001+00:00",
    "FinishDate" : "2022-06-30",
    "LastUpdateDate" : "2022-03-01T20:36:30+00:00",
    "LastUpdatedBy" : "Monica.Suchet",
    "LineOfBusinessCode" : "CONSULTING",
    "LineOfBusinessMeaning" : "Services",
    "ParentProgramId" : 300100549427237,
    "ParentProgramNumber" : "NA202201",
    "PriorityCode" : "ORA_PJS_HIGH",
    "PriorityMeaning" : "High",
    "ProgramDescription" : "Applications for North America",
    "ProjectProgramId" : 300100549427567,
    "ProgramName" : "Hilman & Associates - Applications",
    "ProgramNumber" : "NA202201-1",
    "ProgramObjective" : "Coordinate and track strategic programs to achieve high customer satisfaction and expand market share.",
    "ProgramStatusName" : "Active",
    "ProgramSystemStatusCode" : "ORA_PROGRAM_ACTIVE",
    "PublicFlag" : false,
    "RegionCode" : "PROGRAM_NORTH_AMERICA",
    "RegionMeaning" : "North America",
    "StartDate" : "2022-01-01",
    "StrategyCode" : "SERVICE_EXCELLENCE",
    "StrategyMeaning" : "Service excellence",
    "TreeStructureId" : 300100549427237,
    "OwningOrganizationName" : "Vision Operations",
    "OwningOrganizationId" : 204,
    "ProgramBudget" : 11174772,
    "ProgramBudgetCurrency" : "USD",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567",
      "name" : "projectPrograms",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567",
      "name" : "projectPrograms",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramAvatars",
      "name" : "ProgramAvatars",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramNotes",
      "name" : "ProgramNotes",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramProjects",
      "name" : "ProgramProjects",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramStakeholders",
      "name" : "ProgramStakeholders",
            "kind": "collection"
        }
    ]
}

Back to Top