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

Get all award projects

get

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

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 project with the specified award project ID.
      Finder Variables:
      • AwardProjectId; integer; Identifier of the award project.
  • 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; Unique identifier of the award.
    • AwardName; string; Name of the award. Mandatory for POST operation.
    • AwardNumber; string; Number of the award.
    • AwardProjectId; integer; Unique identifier of the award project.
    • BurdenScheduleFixedDate; string; Specific date used to determine the right set of burden multipliers for the award project.
    • BurdenScheduleId; integer; The unique identifier of the burden schedule.
    • BurdenScheduleName; string; Name of the burden schedule assigned at the award project level.
    • CreatedBy; string; The user that created the award project
    • CreationDate; string; The date when the award project was created.
    • CurrencyCode; string; Currency code representing the award project currency.
    • LastUpdateDate; string; The date when the award project was last updated.
    • LastUpdatedBy; string; The user that last updated the award project.
    • ProjectId; integer; Unique identifier of the award project.
    • ProjectName; string; Name of the project associated to the award.
    • ProjectNumber; string; Number of the project associated to the award.
  • 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-AwardProject
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : awards-AwardProject-item-response
Type: object
Show Source
Nested Schema : Award Project Attachments
Type: array
Title: Award Project Attachments
The Award Project Attachments resource is used to view attachments associated with the award project.
Show Source
Nested Schema : Award Project Certifications
Type: array
Title: Award Project Certifications
The Award Project Certifications resource is used to view certification attributes of the award project.
Show Source
Nested Schema : Award Project Organization Credits
Type: array
Title: Award Project Organization Credits
The Award Project Organization Credits resource is used to view organization credit attributes for the award project.
Show Source
Nested Schema : Award Project Descriptive Flexfields
Type: array
Title: Award Project Descriptive Flexfields
A list of all the descriptive flexfields available for award projects.
Show Source
Nested Schema : Award Project Funding Sources
Type: array
Title: Award Project Funding Sources
The Award Project Funding Sources resource is used to assign funding sources to the award project.
Show Source
Nested Schema : Award Project Keywords
Type: array
Title: Award Project Keywords
The Award Project Keywords resource is used to view keyword attributes for the award project.
Show Source
Nested Schema : Award Project Override Burden Schedules
Type: array
Title: Award Project Override Burden Schedules
The Award Project Override Burden Schedules resource is used to create and view the override burden schedule assigned to the award project.
Show Source
Nested Schema : Award Project Personnel
Type: array
Title: Award Project Personnel
The Award Project Personnel resource is used to view personnel references associated with the award project
Show Source
Nested Schema : Award Project Reference Types
Type: array
Title: Award Project Reference Types
The Award Project Reference Types resource is used to view attributes associated with the award project reference type.
Show Source
Nested Schema : Award Project Task Burden Schedules
Type: array
Title: Award Project Task Burden Schedules
The Award Project Task Burden Schedules resource is used to view the task burden schedule of the award project.
Show Source
Nested Schema : awards-AwardProject-AwardProjectAttachment-item-response
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectCertification-item-response
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectDepartmentCredit-item-response
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectDFF-item-response
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectFundingSource-item-response
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectKeyword-item-response
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectOverrideBurdenSchedules-item-response
Type: object
Show Source
  • Title: Award ID
    Identifier of the award.
  • Title: Award Project ID
    Identifier of the award project.
  • Title: Description
    Maximum Length: 250
    The description of a burden schedule which is set of burden multipliers that is maintained for use across projects.
  • Title: Burden Schedule ID
    Read Only: true
    Identifier of the burden schedule.
  • Title: Burden Schedule
    Maximum Length: 30
    The name of a burden schedule which is set of burden multipliers that is maintained for use across projects.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Default Burden Structure
    Maximum Length: 30
    The name of a burden structure which is assigned as the default burden structure on a burden schedule. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases.
  • Title: Default Organization Hierarchy Code
    Maximum Length: 30
    The internal code of the structure that determines the relationships between organizations.
  • Title: Default Organization Hierarchy
    Maximum Length: 80
    A structure that determines the relationships between organizations like which organizations are subordinate to other organizations. This hierarchy is the default hierarchy for burden schedule versions.
  • Title: Hierarchy Start Organization ID
    The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule.
  • Title: Hierarchy Start Organization
    Maximum Length: 240
    The top-level organization of the organization hierarchy that is assigned to the burden schedule.
  • Title: Hierarchy Version ID
    Maximum Length: 32
    The identifier of the version of the organization hierarchy that is assigned to the burden schedule.
  • Title: Hierarchy Version
    Maximum Length: 80
    The version of the organization hierarchy that is assigned to the burden schedule.
  • Title: Last Updated Date
    Read Only: true
    The user who last updated the record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The date when the record was last updated.
  • Links
  • Title: Organization Classification Code
    The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks.
  • Title: Organization Classification
    The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks.
  • Versions
    Title: Versions
    The Versions resource is used to view and create versions for the override burden schedule assigned to the award project.
Nested Schema : Versions
Type: array
Title: Versions
The Versions resource is used to view and create versions for the override burden schedule assigned to the award project.
Show Source
Nested Schema : awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-item-response
Type: object
Show Source
  • Title: Build Status
    Read Only: true
    Maximum Length: 80
    The current state of a burden schedule version in relation to build processing. The status can be New, Active, or Active with Unbuilt Changes.
  • Title: Burden Schedule ID
    Identifier of the burden schedule.
  • Title: Burden Structure
    Maximum Length: 30
    The name of a burden structure which is assigned to a burden schedule version. A burden structure determines how cost bases are grouped and what types of burden costs are applied to the cost bases.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Hierarchy Start Organization ID
    The identifier of the top-level organization of the organization hierarchy that is assigned to the burden schedule version.
  • Title: Hierarchy Start Organization
    Maximum Length: 240
    The top-level organization of the organization hierarchy that is assigned to the burden schedule version.
  • Title: Hierarchy Version ID
    Maximum Length: 32
    The identifier of the version of the organization hierarchy that is assigned to the burden schedule version.
  • Title: Hierarchy Version
    Maximum Length: 80
    The version of the organization hierarchy that is assigned to the burden schedule version.
  • Title: Hold Version from Build
    Maximum Length: 1
    Indicates that the build rate schedule process will skip the schedule version even if it has been built.
  • Title: Last Active Build Date
    Read Only: true
    The date on which a burden schedule version most recently underwent successful build processing. Because the processing was successful, the multipliers on the version are available for use.
  • Title: Last Updated Date
    Read Only: true
    The user who last updated the record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The date when the record was last updated.
  • Links
  • Multipliers
    Title: Multipliers
    The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.
  • Title: Organization Classification Code
    The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks.
  • Title: Organization Classification
    The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks.
  • Title: Organization Hierarchy Code
    Maximum Length: 30
    The internal code of the structure that determines the relationships between organizations.
  • Title: Organization Hierarchy
    Maximum Length: 80
    A structure that determines the relationships between organizations like which organizations are subordinate to other organizations.
  • Title: To Date
    The date after which a burden schedule version is no longer active.
  • Title: Version ID
    Read Only: true
    The identifier of the version of a set of burden multipliers.
  • Title: Version
    Maximum Length: 30
    A version of a burden schedule is a set of burden multipliers. One burden schedule can have many versions.
  • Title: From Date
    The date from which a burden schedule version is active.
Nested Schema : Multipliers
Type: array
Title: Multipliers
The Multipliers resource is used to view and create multipliers for the override burden schedule assigned to the award project.
Show Source
Nested Schema : awards-AwardProject-AwardProjectOverrideBurdenSchedules-Versions-Multipliers-item-response
Type: object
Show Source
  • Title: Burden Cost Code
    Maximum Length: 30
    The name of a burden cost code for which you are defining multipliers on a burden schedule version. A burden cost code is a classification of overhead costs and it represents the type of burden cost you want to apply to raw cost.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Last Updated Date
    Read Only: true
    The user who last updated the record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The date when the record was last updated.
  • Links
  • Title: Multiplier ID
    Read Only: true
    Identifier of the burden multiplier.
  • Title: Multiplier
    A numeric multiplier associated with an organization and burden cost code combinations for burden schedule versions. The costing process applies this multiplier to raw cost to calculate burden cost amounts.
  • Title: Organization Classification Code
    The internal code for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks.
  • Title: Organization Classification
    The name for a group of organizations to classify them, for example, to allow to own the enterprise's projects or project tasks, or to incur costs on the enterprise's projects or project tasks.
  • Title: Organization ID
    Identifier of the organization to which a burden multiplier is assigned for a particular burden cost code.
  • Title: Organization
    Maximum Length: 240
    The organization to which a burden multiplier is assigned for a particular burden cost code.
  • Title: Version ID
    The identifier of the version of a set of burden multipliers.
Nested Schema : awards-AwardProject-AwardProjectPersonnel-item-response
Type: object
Show Source
Nested Schema : Award Project Personnel Descriptive Flexfields
Type: array
Title: Award Project Personnel Descriptive Flexfields
A list of all the descriptive flexfields available for award project personnel.
Show Source
Nested Schema : awards-AwardProject-AwardProjectPersonnel-AwardProjectPersonnelDFF-item-response
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectReference-item-response
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectTaskBurdenSchedule-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all award projects 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/AwardProject

Response Body Example

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

{
"items": [
  {
"AwardProjectId": 300100043492147,
"AwardId": 300100043712585,
"AwardName": "PJC_XCC_GMS_VCO_NB Award",
"AwardNumber": "PJC_XCC_GMS_VCO_NB_A",
"ProjectId": 300100043492137,
"ProjectName": "PJC_XCC_GMS_VCO_NB_P1",
"ProjectNumber": "PJC_XCC_GMS_VCO_NB_P1",
"BurdenScheduleId": null,
"BurdenScheduleName": null,
"BurdenScheduleFixedDate": null,
"CurrencyCode": "USD",
"CreatedBy": "Mark.Williams",
"LastUpdateDate": "2014-08-06T23:30:00.557+00:00",
"CreationDate": "2014-08-06T23:17:37+00:00",
"LastUpdatedBy": "Mark.Williams"
}
Back to Top