REST API for Oracle Fusion Cloud Project Management

Create a stakeholder

post

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

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

Effective-Of:

This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
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.
Upsert-Mode:

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

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.
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":{
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

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.

Root 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"
    }
}

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."
        }
    }
}

Examples

The following example shows how to create a program.

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

Request Body Example

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

{
"PersonId"300100083497916,

"AccessType":"Stakeholder"
}

Response Body Example

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

{
  "StakeholderAssociationId" : 300100549427570,
  "AccessTypeCode" : "ORA_PJS_VIEW_ONLY",
  "AccessType" : "Stakeholder",
  "AssignmentCategoryCode" : "ORA_PJS_DIRECT",
  "AssignmentCategory" : "Direct",
  "CreatedBy" : "Monica.Suchet",
  "CreationDate" : "2022-03-01T21:10:55.001+00:00",
  "LastUpdateDate" : "2022-03-02T03:42:17+00:00",
  "LastUpdatedBy" : "Monica.Suchet",
  "PersonId" : 300100083497916,
  "PersonName" : "Alberto Trevi",
  "PersonEmail" : "sendmail-test-discard@oracle.com",
  "ImageId" : null,
  "ImageName" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramStakeholders/300100549427570",
    "name" : "ProgramStakeholders",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramStakeholders/300100549427570",
    "name" : "ProgramStakeholders",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567",
    "name" : "projectPrograms",
    "kind" : "item"
  }, {
    "rel" : "enclosure",
    "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramStakeholders/300100549427570/enclosure/Image",
    "name" : "Image",
    "kind" : "other"
  } ]
}