1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Awards
  4. Award Personnel

Get all award personnels

get

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel

Request

Path Parameters
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>
  • 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 an award personnel record with the specified id.
      Finder Variables:
      • AwardPersonnelId; integer; Identifier of the award personnel.
  • 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:
    • AwardId; integer; The unique identifier of the award.
    • AwardPersonnelId; integer; The unique identifier for award personnel association.
    • CreatedBy; string; The user that created the award personnel.
    • CreationDate; string; The date when the award personnel was created.
    • CreditPercent; number; Credit percentage value associate for the selected person.
    • EmailAddress; string; Email Address for the selected person from Human Resources.
    • EndDate; string; End date of the duration for the award person associateion.
    • InternalFlag; boolean; Indicates whether the selected person is internal or external.
    • JobTitle; string; Job Title of the person selected from Human Resources.
    • LastUpdateDate; string; The date when the award personnel was last updated.
    • LastUpdatedBy; string; The user that last updated the award personnel.
    • OrganizationName; string; Name of the Organization of the selected person.
    • PartyId; integer; The unique identifier of the selected external person.
    • PersonId; integer; The unique identifier of the selected internal person from Human Resources.
    • PersonName; string; Name of the person in HCM.
    • PersonNumber; string; Person number of the person.
    • PhoneNumber; string; Phone number of the person selected from Human Resources to administer and manage awards.
    • Role; string; The role performed by the selected person.
    • RoleId; integer; Unique identifier of the selected role of the person.
    • StartDate; string; Start date of the duration for the award person association.
  • 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
  • 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 : awards-AwardPersonnel
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : awards-AwardPersonnel-item-response
Type: object
Show Source
Nested Schema : Award Personnel Descriptive Flexfields
Type: array
Title: Award Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award personnel.
Show Source
Nested Schema : awards-AwardPersonnel-AwardPersonnelDFF-item-response
Type: object
Show Source
Back to Top

Examples

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

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100043712585/child/AwardPersonnel

Response Body Example

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

{ "items": [ { "AwardPersonnelId": 300100043492117, "AwardId": 300100043712585, "PersonName": "phil Williams", "PersonNumber": "955160008176132", "PhoneNumber": null, "EmailAddress": "prj_phil_williams_grp@oracle.com", "JobTitle": "Consultant", "OrganizationName": "Vision City Maintenance", "PersonId": 300100026354758, "PartyId": null, "InternalFlag": true, "RoleId": 2, "Role": "Principal Investigator", "StartDate": "2011-10-01", "EndDate": "2016-09-30", "CreditPercent": 100, "CreatedBy": "Mark.Williams", "CreationDate": "2014-08-06T23:12:41.904+00:00", "LastUpdatedBy": "Mark.Williams", "LastUpdateDate": "2014-08-06T23:12:50.753+00:00" }
Back to Top