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

Update an award

patch

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

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Award Attachments
Type: array
Title: Award Attachments
The Award Attachments resource is used to view attachments associated with the award.
Show Source
Nested Schema : Award Budget Periods
Type: array
Title: Award Budget Periods
The Award Budget Periods resource is used to view award budget period attributes such as budget period name, start date and end date.
Show Source
Nested Schema : Award Certifications
Type: array
Title: Award Certifications
The Award Certifications resource is used to view the certification attributes of the award.
Show Source
Nested Schema : Award CFDAs
Type: array
Title: Award CFDAs
The Award CFDAs resource is used to view the attributes specific to award federal domestic assistance program.
Show Source
Nested Schema : Award Department Credits
Type: array
Title: Award Department Credits
The Award Department Credits resource is used to view the organization credit attributes for the award.
Show Source
Nested Schema : Award Errors
Type: array
Title: Award Errors
The Award Errors resource is used to view validation errors associated with the award.
Show Source
Nested Schema : Award Fundings
Type: array
Title: Award Fundings
The Award Fundings resource is used to view award funding attributes such as funding issue type and funding issue name.
Show Source
Nested Schema : Award Funding Sources
Type: array
Title: Award Funding Sources
The Award Funding Sources resource is used to view the attributes used to create or update a funding source for the award.
Show Source
Nested Schema : Award Descriptive Flexfields
Type: array
Title: Award Descriptive Flexfields
A list of all the descriptive flexfields available for awards.
Show Source
Nested Schema : Award Keywords
Type: array
Title: Award Keywords
The Award Keywords resource is used to view the keyword attributes for the award.
Show Source
Nested Schema : Award Personnel
Type: array
Title: Award Personnel
The Award Personnel resource is used to view the award personnel attributes such as person name, role.
Show Source
Nested Schema : Award Projects
Type: array
Title: Award Projects
The Award Projects resource is used to view the attributes of an award project, such as project name and project number.
Show Source
Nested Schema : Award References
Type: array
Title: Award References
The Award References resource is used to view the attributes specific to award reference type.
Show Source
Nested Schema : Award Terms
Type: array
Title: Award Terms
The Award Terms and Conditions resource is used to view the attributes of the terms and conditions associated to the award.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : awards-AwardCFDA-item-patch-request
Type: object
Show Source
  • Title: Assistance Listing Numbers
    Maximum Length: 30
    Number used to identify the nature of federal funding received in the form of award from sponsors.
Nested Schema : schema
Type: object
Show Source
Nested Schema : awards-AwardError-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Award Project Fundings
Type: array
Title: Award Project Fundings
The Award Project Fundings resource is used to view funding allocation attributes for the award project.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : awards-AwardPersonnel-item-patch-request
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-patch-request
Type: object
Show Source
Nested Schema : schema
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-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectDepartmentCredit-item-patch-request
Type: object
Show Source
Nested Schema : awards-AwardProject-AwardProjectDFF-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
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
    Maximum Length: 30
    The name of a burden schedule which is set of burden multipliers that is maintained for use across projects.
  • 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: 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-patch-request
Type: object
Show Source
  • 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: 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.
  • 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
    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 : schema
Type: object
Show Source
  • 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
    Maximum Length: 240
    The organization to which a burden multiplier is assigned for a particular burden cost code.
Nested Schema : schema
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-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
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-item-response
Type: object
Show Source
Nested Schema : Award Attachments
Type: array
Title: Award Attachments
The Award Attachments resource is used to view attachments associated with the award.
Show Source
Nested Schema : Award Budget Periods
Type: array
Title: Award Budget Periods
The Award Budget Periods resource is used to view award budget period attributes such as budget period name, start date and end date.
Show Source
Nested Schema : Award Certifications
Type: array
Title: Award Certifications
The Award Certifications resource is used to view the certification attributes of the award.
Show Source
Nested Schema : Award CFDAs
Type: array
Title: Award CFDAs
The Award CFDAs resource is used to view the attributes specific to award federal domestic assistance program.
Show Source
Nested Schema : Award Department Credits
Type: array
Title: Award Department Credits
The Award Department Credits resource is used to view the organization credit attributes for the award.
Show Source
Nested Schema : Award Errors
Type: array
Title: Award Errors
The Award Errors resource is used to view validation errors associated with the award.
Show Source
Nested Schema : Award Fundings
Type: array
Title: Award Fundings
The Award Fundings resource is used to view award funding attributes such as funding issue type and funding issue name.
Show Source
Nested Schema : Award Funding Sources
Type: array
Title: Award Funding Sources
The Award Funding Sources resource is used to view the attributes used to create or update a funding source for the award.
Show Source
Nested Schema : Award Descriptive Flexfields
Type: array
Title: Award Descriptive Flexfields
A list of all the descriptive flexfields available for awards.
Show Source
Nested Schema : Award Keywords
Type: array
Title: Award Keywords
The Award Keywords resource is used to view the keyword attributes for the award.
Show Source
Nested Schema : Award Personnel
Type: array
Title: Award Personnel
The Award Personnel resource is used to view the award personnel attributes such as person name, role.
Show Source
Nested Schema : Award Projects
Type: array
Title: Award Projects
The Award Projects resource is used to view the attributes of an award project, such as project name and project number.
Show Source
Nested Schema : Award References
Type: array
Title: Award References
The Award References resource is used to view the attributes specific to award reference type.
Show Source
Nested Schema : Award Terms
Type: array
Title: Award Terms
The Award Terms and Conditions resource is used to view the attributes of the terms and conditions associated to the award.
Show Source
Nested Schema : awards-Attachment-item-response
Type: object
Show Source
Nested Schema : awards-AwardBudgetPeriod-item-response
Type: object
Show Source
Nested Schema : awards-AwardCertification-item-response
Type: object
Show Source
Nested Schema : awards-AwardCFDA-item-response
Type: object
Show Source
Nested Schema : awards-AwardDepartmentCredit-item-response
Type: object
Show Source
Nested Schema : awards-AwardError-item-response
Type: object
Show Source
Nested Schema : awards-AwardFunding-item-response
Type: object
Show Source
Nested Schema : Award Project Fundings
Type: array
Title: Award Project Fundings
The Award Project Fundings resource is used to view funding allocation attributes for the award project.
Show Source
Nested Schema : awards-AwardFunding-AwardProjectFunding-item-response
Type: object
Show Source
Nested Schema : awards-AwardFundingSource-item-response
Type: object
Show Source
Nested Schema : awards-AwardHeaderDFF-item-response
Type: object
Show Source
Nested Schema : awards-AwardKeyword-item-response
Type: object
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
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
Nested Schema : awards-AwardReference-item-response
Type: object
Show Source
Nested Schema : awards-AwardTerms-item-response
Type: object
Show Source
Links
Attachment
Parameters:
  • AwardId: $request.path.AwardId
The Award Attachments resource is used to view attachments associated with the award.
AwardBudgetPeriod
Parameters:
  • AwardId: $request.path.AwardId
The Award Budget Periods resource is used to view award budget period attributes such as budget period name, start date and end date.
AwardCFDA
Parameters:
  • AwardId: $request.path.AwardId
The Award CFDAs resource is used to view the attributes specific to award federal domestic assistance program.
AwardCertification
Parameters:
  • AwardId: $request.path.AwardId
The Award Certifications resource is used to view the certification attributes of the award.
AwardDepartmentCredit
Parameters:
  • AwardId: $request.path.AwardId
The Award Department Credits resource is used to view the organization credit attributes for the award.
AwardError
Parameters:
  • AwardId: $request.path.AwardId
The Award Errors resource is used to view validation errors associated with the award.
AwardFunding
Parameters:
  • AwardId: $request.path.AwardId
The Award Fundings resource is used to view award funding attributes such as funding issue type and funding issue name.
AwardFundingSource
Parameters:
  • AwardId: $request.path.AwardId
The Award Funding Sources resource is used to view the attributes used to create or update a funding source for the award.
AwardHeaderDFF
Parameters:
  • AwardId: $request.path.AwardId
A list of all the descriptive flexfields available for awards.
AwardKeyword
Parameters:
  • AwardId: $request.path.AwardId
The Award Keywords resource is used to view the keyword attributes for the award.
AwardPersonnel
Parameters:
  • AwardId: $request.path.AwardId
The Award Personnel resource is used to view the award personnel attributes such as person name, role.
AwardProject
Parameters:
  • AwardId: $request.path.AwardId
The Award Projects resource is used to view the attributes of an award project, such as project name and project number.
AwardReference
Parameters:
  • AwardId: $request.path.AwardId
The Award References resource is used to view the attributes specific to award reference type.
AwardTerms
Parameters:
  • AwardId: $request.path.AwardId
The Award Terms and Conditions resource is used to view the attributes of the terms and conditions associated to the award.
Back to Top

Examples

The following example shows how to update an award by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429

Request Body Example

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

{	
"ContractStatus": "Active",
"DocumentNumber": “12345”
}

Response Body Example

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

{
    "AwardId": 300100185192429,
    "AwardName": "testAward",
    "AwardNumber": "testAward",
    "BusinessUnitId": 300100014554154,
    "BusinessUnitName": "Vision City Operations",
    "CurrencyCode": "USD",
    "LegalEntityId": 300100014516903,
    "LegalEntityName": "Vision City LE",
    "SponsorId": 300100038787368,
    "SponsorName": "Dept of Health and Human Services (DHHS)",
    "SponsorNumber": "CDRM_70255",
    "StartDate": "2016-01-01",
    "EndDate": "2025-12-31",
    "PrincipalInvestigatorId": 300100026354758,
    "PrincipalInvestigatorName": "phil Williams",
    "PrincipalInvestigatorNumber": null,
    "PrincipalInvestigatorEmail": null,
    "ExpandedAuthorityFlag": null,
    "BurdenScheduleId": 300100038787360,
    "BurdenScheduleName": "Award Burden Schedule",
    "BurdenScheduleFixedDate": null,
    "ContractTypeName": null,
    "CloseDate": "2026-01-30",
    "AwardType": "GRNT",
    "DaysToClose": null,
    "SponsorAwardNumber": null,
    "AwardOwningOrganizationId": 300100017216727,
    "AwardOwningOrganizationName": "Vision City Maintenance",
    "AwardPurposeCode": null,
    "AwardPurpose": null,
    "Description": null,
    "SourceAwardName": null,
    "InstitutionId": 300100039540628,
    "InstitutionName": "Steffon University",
    "ContractLineName": null,
    "DocumentNumber": "12345",
    "LetterOfCreditFlag": true,
    "RevenuePlanName": null,
    "BillPlanName": null,
    "LaborFormatId": null,
    "LaborFormat": null,
    "EventFormatId": null,
    "EventFormat": null,
    "NonLaborFormatId": null,
    "NonLaborFormat": null,
    "RevenueMethodId": null,
    "RevenueMethod": null,
    "PaymentTermsId": null,
    "PaymentTerms": null,
    "BillingCycleId": null,
    "BillingCycle": null,
    "InvoiceMethodId": null,
    "InvoiceMethod": null,
    "FederalInvoiceFormat": null,
    "FederalInvoiceFormatCode": null,
    "ContractTypeId": null,
    "ContractStatus": "Active",
    "CreatedBy": "Alice.Parker",
    "CreationDate": "2020-06-04T05:37:20+00:00",
    "LastUpdatedBy": "Alice.Parker",
    "LastUpdateDate": "2020-06-04T05:40:38+00:00",
    "InstitutionComplianceApprovalDate": null,
    "InstitutionComplianceFlag": null,
    "InstitutionComplianceReviewCompletedFlag": null,
    "FlowThroughFromDate": null,
    "FlowThroughToDate": null,
    "FlowThroughFederalFlag": null,
    "FlowThroughPrimarySponsorId": null,
    "FlowThroughPrimarySponsorName": null,
    "FlowThroughPrimarySponsorNumber": null,
    "FlowThroughReferenceAwardName": null,
    "FlowThroughAmount": null,
    "PreviousAwardBUId": null,
    "PreviousAwardBUName": null,
    "PreviousAwardId": null,
    "PreviousAwardName": null,
    "PreviousAwardNumber": null,
    "PreviousAwardInProgressRenewFlag": null,
    "PreviousAwardAccomplishmentRenewFlag": null,
    "IntellectualPropertyDescription": null,
    "IntellectualPropertyReportedFlag": null,
    "PreAwardSpendingAllowedFlag": null,
    "PreAwardGuaranteedFundingSource": null,
    "PreAwardDate": null,
    "ValidateStatus": "C",
    "AwardValidationNeededFlag": null,
    "LastValidated": "2020-06-04T05:40:39.709+00:00",
    "SourceTemplateId": null,
    "SourceTemplateName": null,
    "SourceTemplateNumber": null,
    "CreatedFrom": null,
    "AwardSource": null,
    "links": [
        {
            "rel": "self",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429",
            "name": "awards",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429",
            "name": "awards",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/LedgerLeVVA",
            "name": "LedgerLeVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/AwardInstitutionVVA",
            "name": "AwardInstitutionVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/AwardTemplateForCopyVVA",
            "name": "AwardTemplateForCopyVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/LaborFormatVVA",
            "name": "LaborFormatVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/RevenueMethodVVA",
            "name": "RevenueMethodVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/GrantsPersonPVA",
            "name": "GrantsPersonPVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/InvoiceStructureLookupPVA",
            "name": "InvoiceStructureLookupPVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/GrantsContractTypeVA",
            "name": "GrantsContractTypeVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/AwardBurdenSchedulePVA",
            "name": "AwardBurdenSchedulePVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/PreviousAwardDetailVVA",
            "name": "PreviousAwardDetailVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/AwardOwningOrganizationPVA",
            "name": "AwardOwningOrganizationPVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/EventFormatVVA",
            "name": "EventFormatVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/InvoiceMethodVVA",
            "name": "InvoiceMethodVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/SponsorVVA",
            "name": "SponsorVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/AwardTypeLookupPVA",
            "name": "AwardTypeLookupPVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/PaymentTermVVA",
            "name": "PaymentTermVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/BusinessUnitVA",
            "name": "BusinessUnitVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/NonLaborFormatVVA",
            "name": "NonLaborFormatVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/BillingCyclePVA",
            "name": "BillingCyclePVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/TxnCurrencyVVA",
            "name": "TxnCurrencyVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/lov/AwardPurposeLookupPVA",
            "name": "AwardPurposeLookupPVA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/Attachment",
            "name": "Attachment",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardBudgetPeriod",
            "name": "AwardBudgetPeriod",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardCFDA",
            "name": "AwardCFDA",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardCertification",
            "name": "AwardCertification",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardDepartmentCredit",
            "name": "AwardDepartmentCredit",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardError",
            "name": "AwardError",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardFunding",
            "name": "AwardFunding",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardFundingSource",
            "name": "AwardFundingSource",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardHeaderDFF",
            "name": "AwardHeaderDFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardKeyword",
            "name": "AwardKeyword",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardPersonnel",
            "name": "AwardPersonnel",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardProject",
            "name": "AwardProject",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardReference",
            "name": "AwardReference",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awards/300100185192429/child/AwardTerms",
            "name": "AwardTerms",
            "kind": "collection"
        }
    ]
}
Back to Top