Get all stakeholders

get

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

Request

Path Parameters
  • 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
  • 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>
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds a stakeholder assignment for the specified primary key.
      Finder Variables
      • StakeholderAssociationId; integer; The unique identifier of the stakeholder assignment to a program.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • 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; 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; 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; 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; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • ImageId; integer; The unique identifier of the avatar image for a person.
    • ImageName; string; The name of the avatar image for a person.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the record.
    • PersonEmail; string; The email of the person who's assigned to the program as a stakeholder.
    • PersonId; integer; The unique identifier of the person who's assigned to the program as a stakeholder.
    • PersonName; string; The name of the person who's assigned to the program as a stakeholder.
    • StakeholderAssociationId; integer; The unique identifier of the stakeholder assignment to a program.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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.
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-ProgramStakeholders
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectPrograms-ProgramStakeholders-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • Title: Image
    Read Only: true
    The avatar image for a person.
  • Read Only: true
    The unique identifier of the avatar image for a person.
  • Read Only: true
    Maximum Length: 240
    The name of the avatar image for a person.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Links
  • Title: Email
    Maximum Length: 240
    The email of the person who's assigned to the program as a stakeholder.
  • Title: Person ID
    The unique identifier of the person who's assigned to the program as a stakeholder.
  • Title: Name
    Maximum Length: 240
    The name of the person who's assigned to the program as a stakeholder.
  • Title: Stakeholder Assignment ID
    The unique identifier of the stakeholder assignment to a program.
Back to Top

Examples

The following example shows how to get all stakeholders 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>/child/ProgramStakeholders"

Response Body Example

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

{
  "items" : [ {
    "StakeholderAssociationId" : 300100549427568,
    "AccessTypeCode" : "ORA_PJS_OWNER",
    "AccessType" : "Owner",
    "AssignmentCategoryCode" : "ORA_PJS_OWNER",
    "AssignmentCategory" : "Owner",
    "CreatedBy" : "Monica.Suchet",
    "CreationDate" : "2022-03-01T21:09:06.360+00:00",
    "LastUpdateDate" : "2022-03-01T20:35:25+00:00",
    "LastUpdatedBy" : "Monica.Suchet",
    "PersonId" : 300100082247138,
    "PersonName" : "Monica Suchet",
    "PersonEmail" : "monica.suchet@oracle.demo.com",
    "ImageId" : 300100549442391,
    "ImageName" : "955160008184900-300100549442390",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramStakeholders/300100549427568",
      "name" : "ProgramStakeholders",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramStakeholders/300100549427568",
      "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/300100549427568/enclosure/Image",
      "name" : "Image",
      "kind" : "other"
    } ]
  }, {
    "StakeholderAssociationId" : 100100446709789,
    "AccessTypeCode" : "ORA_PJS_VIEW_ONLY",
    "AccessType" : "Stakeholder",
    "AssignmentCategoryCode" : "ORA_PJS_INHERITED",
    "AssignmentCategory" : "Inherited",
    "CreatedBy" : "Monica.Suchet",
    "CreationDate" : "2022-03-01T20:36:30+00:00",
    "LastUpdateDate" : "2022-03-01T20:35:25+00:00",
    "LastUpdatedBy" : "Monica.Suchet",
    "PersonId" : 300100083167513,
    "PersonName" : "Lilly Arnett",
    "PersonEmail" : "lilly.arnett@oracle.demo.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/100100446709789",
      "name" : "ProgramStakeholders",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramStakeholders/100100446709789",
      "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/100100446709789/enclosure/Image",
      "name" : "Image",
      "kind" : "other"
    } ]
  }, {
    "StakeholderAssociationId" : 300100549427570,
    "AccessTypeCode" : "ORA_PJS_EDIT",
    "AccessType" : "Contributor",
    "AssignmentCategoryCode" : "ORA_PJS_DIRECT",
    "AssignmentCategory" : "Direct",
    "CreatedBy" : "Monica.Suchet",
    "CreationDate" : "2022-03-01T21:10:55.001+00:00",
    "LastUpdateDate" : "2022-03-01T20:35:25+00:00",
    "LastUpdatedBy" : "Monica.Suchet",
    "PersonId" : 300100083497916,
    "PersonName" : "Alberto Trevi",
    "PersonEmail" : "alberto.trevi@oracle.demo.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" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "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"
    } ]

  } ],
  "count" : 3,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549427567/child/ProgramStakeholders",
    "name" : "ProgramStakeholders",
    "kind" : "collection"
  } ]
}
Back to Top