Create award funding
post
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardFunding
Request
Path Parameters
-
AwardId(required): integer(int64)
Unique identifier of the award.
Header Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AwardFundingId: integer
(int64)
Title:
Award Funding IDUnique identifier of the award funding. -
AwardFundingSourceId(required): integer
(int64)
Title:
Award Funding Source IDUnique identifier of the award funding source. -
AwardId(required): integer
(int64)
Title:
Award IDUnique identifier of the award. -
AwardProjectFunding: array
Award Project Fundings
Title:
Award Project FundingsThe Award Project Fundings resource is used to view funding allocation attributes for the award project. -
BudgetPeriod: string
Name of the budget period for the award.
-
BudgetPeriodId(required): integer
(int64)
Title:
Budget Period IDUnique identifier of the award budget period. -
DirectFundingAmount(required): number
Title:
Direct Funding AmountTotal funding amount granted for the award. -
FundingIssueDate(required): string
(date)
Title:
DateDate when the funding was issued. -
FundingIssueDescription: string
Title:
DescriptionMaximum Length:240Description of the funding issue. -
FundingIssueNumber(required): string
Title:
NumberMaximum Length:200Number of the funding issue. -
FundingIssueType(required): string
Title:
TypeMaximum Length:30Type code of funding issued, for example BASE or SUPPLEMENT. -
FundingIssueTypeName: string
Title:
Award Funding Issue TypeMaximum Length:80Type of funding issued, for example Base or Supplement. -
FundingSourceId(required): integer
(int64)
Title:
Funding Source IDUnique identifier of the funding source. -
FundingSourceName: string
Title:
Funding Source NameMaximum Length:360Name of the funding source. -
FundingSourceNumber: string
Title:
Funding Source NumberMaximum Length:50Number of the funding source, entered by the user. -
IndirectFundingAmount: number
Title:
Indirect Funding AmountBurden amount granted by the sponsor as part of funding amount.
Nested Schema : Award Project Fundings
Type:
arrayTitle:
Award Project FundingsThe Award Project Fundings resource is used to view funding allocation attributes for the award project.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AwardId: integer
(int64)
Title:
Award IDUnique identifier of the award. -
AwardProjectFundingId: integer
(int64)
Title:
Award Project Funding IDUnique identifier of the award project funding allocation. -
AwardProjectLinkId: integer
(int64)
Title:
Award Project Link IDUnique identifier of the award project. -
FundingAmount: number
Title:
Funding AmountFunding amount allocated to the award project. -
ProjectId: integer
Title:
Project IDUnique identifier of the award project. -
ProjectName: string
Title:
Project NameName of the project to which the funding is allocated. -
ProjectNumber: string
Title:
Project NumberNumber of the project to which the funding is allocated.
Response
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-AwardFunding-item-response
Type:
Show Source
object-
AwardFundingId: integer
(int64)
Title:
Award Funding IDUnique identifier of the award funding. -
AwardFundingSourceId: integer
(int64)
Title:
Award Funding Source IDUnique identifier of the award funding source. -
AwardId: integer
(int64)
Title:
Award IDUnique identifier of the award. -
AwardProjectFunding: array
Award Project Fundings
Title:
Award Project FundingsThe Award Project Fundings resource is used to view funding allocation attributes for the award project. -
BudgetPeriod: string
Name of the budget period for the award.
-
BudgetPeriodId: integer
(int64)
Title:
Budget Period IDUnique identifier of the award budget period. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user that created the award funding. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the award funding was created. -
CurrencyCode: string
Title:
CurrencyRead Only:trueMaximum Length:15Currency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. -
DirectFundingAmount: number
Title:
Direct Funding AmountTotal funding amount granted for the award. -
FundingIssueDate: string
(date)
Title:
DateDate when the funding was issued. -
FundingIssueDescription: string
Title:
DescriptionMaximum Length:240Description of the funding issue. -
FundingIssueNumber: string
Title:
NumberMaximum Length:200Number of the funding issue. -
FundingIssueType: string
Title:
TypeMaximum Length:30Type code of funding issued, for example BASE or SUPPLEMENT. -
FundingIssueTypeName: string
Title:
Award Funding Issue TypeMaximum Length:80Type of funding issued, for example Base or Supplement. -
FundingSourceId: integer
(int64)
Title:
Funding Source IDUnique identifier of the funding source. -
FundingSourceName: string
Title:
Funding Source NameMaximum Length:360Name of the funding source. -
FundingSourceNumber: string
Title:
Funding Source NumberMaximum Length:50Number of the funding source, entered by the user. -
IndirectFundingAmount: number
Title:
Indirect Funding AmountBurden amount granted by the sponsor as part of funding amount. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the award funding was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user that last updated the award funding. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Award Project Fundings
Type:
arrayTitle:
Award Project FundingsThe Award Project Fundings resource is used to view funding allocation attributes for the award project.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : awards-AwardFunding-AwardProjectFunding-item-response
Type:
Show Source
object-
AwardId: integer
(int64)
Title:
Award IDUnique identifier of the award. -
AwardProjectFundingId: integer
(int64)
Title:
Award Project Funding IDUnique identifier of the award project funding allocation. -
AwardProjectLinkId: integer
(int64)
Title:
Award Project Link IDUnique identifier of the award project. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user that created the award project funding allocation. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the award project funding allocation was created. -
CurrencyCode: string
Title:
CurrencyRead Only:trueCurrency code representing the award currency. The currency code is a three-letter ISO code associated with a currency. -
FundingAmount: number
Title:
Funding AmountFunding amount allocated to the award project. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the award project funding allocation was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user that last updated the award project funding allocation. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProjectId: integer
Title:
Project IDUnique identifier of the award project. -
ProjectName: string
Title:
Project NameName of the project to which the funding is allocated. -
ProjectNumber: string
Title:
Project NumberNumber of the project to which the funding is allocated.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- AwardProjectFunding
-
Parameters:
- AwardFundingId:
$request.path.AwardFundingId - AwardId:
$request.path.AwardId
The Award Project Fundings resource is used to view funding allocation attributes for the award project. - AwardFundingId: