Get all award personnels
get
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardPersonnel
Request
Path Parameters
- AwardId(required): integer(int64) Unique identifier of the award.
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 - finder: string 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.
- PrimaryKey: Finds an award personnel record with the specified id.
- limit: integer 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.
- 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 - offset: integer 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.
- onlyData: boolean The resource item payload will be filtered in order to contain only data (no links section, for example).
- orderBy: string 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
- q: string 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.
- totalResults: boolean 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
- Metadata-Context: string 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: string 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 TopResponse
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 : awards-AwardPersonnel
Type:
Show Source object
- count(required): integer The number of resource instances returned in the current range.
- hasMore(required): boolean Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
- items: array Items Title:
Items
The items in the collection. - limit(required): integer The actual paging size used by the server.
- links(required): array Links Title:
Links
The link relations associated with the resource instance. - offset(required): integer The offset value used in the current page.
- totalResults: integer The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : awards-AwardPersonnel-item-response
Type:
Show Source object
- AwardId: integer (int64) Title:
Award ID
The unique identifier of the award. - AwardPersonnelDFF: array Award Personnel Descriptive Flexfields Title:
Award Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award personnel. - AwardPersonnelId: integer (int64) Title:
Award Personnel
The unique identifier for award personnel association. - CreatedBy: string Read Only:
true
Maximum Length:64
The user that created the award personnel. - CreationDate: string (date-time) Read Only:
true
The date when the award personnel was created. - CreditPercent: number Credit percentage value associate for the selected person.
- EmailAddress: string Title:
Email
Email Address for the selected person from Human Resources. - EndDate: string (date) Title:
End Date
End date of the duration for the award person associateion. - InternalFlag: boolean Title:
Internal
Maximum Length:1
Default Value:true
Indicates whether the selected person is internal or external. - JobTitle: string Title:
Primary Job
Job Title of the person selected from Human Resources. - LastUpdateDate: string (date-time) Read Only:
true
The date when the award personnel was last updated. - LastUpdatedBy: string Read Only:
true
Maximum Length:64
The user that last updated the award personnel. - links: array Links Title:
Links
The link relations associated with the resource instance. - OrganizationName: string Title:
Primary Organization
Name of the Organization of the selected person. - PartyId: integer (int64) The unique identifier of the selected external person.
- PersonId: integer (int64) The unique identifier of the selected internal person from Human Resources.
- PersonName: string Title:
Person Name
Name of the person in HCM. - PersonNumber: string Title:
Person Number
Person number of the person. - PhoneNumber: string Title:
Phone
Phone number of the person selected from Human Resources to administer and manage awards. - Role: string Title:
Role
Maximum Length:240
The role performed by the selected person. - RoleId: integer (int64) Unique identifier of the selected role of the person.
- StartDate: string (date) Title:
Start Date
Start date of the duration for the award person association.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : awards-AwardPersonnel-AwardPersonnelDFF-item-response
Type:
Show Source object
- __FLEX_Context: string Title:
Context Segment
Maximum Length:30
Structure definition of the Award Personnel Descriptive Flexfield. - __FLEX_Context_DisplayValue: string Title:
Context Segment
Context Segment - Id: integer (int64) System-generated primary key column.
- links: array Links Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source Nested Schema : link
Type:
Show Source object
- href: string Title:
hyperlink reference
The URI to the related resource. - kind: string Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. - name: string Title:
name
The name of the link to the related resource. - properties: object properties
- rel: string Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source object
- changeIndicator: string Change indicator or the ETag value of the resource instance.
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" }